当前位置: 首页 > 文档资料 > BindingX 中文文档 >

APIs

优质
小牛编辑
128浏览
2023-12-01

模块名称

BindingX

接口定义

  • prepare

  • bind

  • unbind

  • unbindAll

  • supportFeatures

  • getComputedStyle

API入参及返回值说明

prepare(params)

开启绑定,此方法仅用于eventTypepan的情况。其他类型的eventType可不调用此方法。

  • 入参类型: 接收一个参数,参数类型是Object

  • 入参详细说明:

    • params:(Object)

      • anchor(String): 锚点,待绑定的view引用(可选)

      • eventType(String): 事件类型。目前支持pan/scroll/timing/orientation四种类型。

  • 返回值:

  • 注: 目前仅手势(pan)需要prepare

bind(params,callback)

创建一个支持特定事件类型的ExpressionBinding实例。当特定事件触发时,将会执行相应的表达式集合,并对指定的视图元素进行视图变换。

  • 入参类型: 接收两个参数,第一个参数是Object类型的具体配置,第二个参数是状态的回调

  • 入参详细说明:

    • params:(Object)

      • eventType: 事件类型(如pan),必选。

      • exitExpression: 边界条件,可选

        • transformed(String): 转化后的表达式

        • origin(String): 原始表达式

      • props: 运行时参数列表(Array),必选

        • element(String): 作用的元素(View)

        • property(String): 作用的属性

        • expression(String): 运行时的表达式

          • transformed(String): 转化后的表达式

          • origin(String): 原始表达式

        • config: 额外配置

          • perspective(Int): 透视。用于调整camera位置。

          • transformOrigin(String): 轴心。格式为(left|right|center top|bottom|center)。比如 left center。

      • anchor: 锚点(可选, 目前仅pan/scroll需要指定锚点)

    • callback:(function)

      • state 运行时的状态回调,通常包括start|end|exit

  • 返回值:

  • token: 用于unbind,eventType为pan/scroll时即anchortiming/orientation时系统生成。(Object类型)

  • 注: 对于pan/scroll类型,token即anchor,对同一个anchor多次bind,则会覆盖

unbind(params)

解绑指定的ExpressionBinding实例。

  • 入参类型: 接收一个参数,类型为Object

  • 入参详细说明:

    • params:(Object)

      • token: 由bind方法返回的特定ExpressionBinding实例. (必选)

      • eventType: 事件类型(如pan). (必选)

  • 返回值: 无

unbindAll()

解绑所有的ExpressionBinding实例。

  • 入参类型: 无

  • 返回值: 无

supportFeatures()

返回当前组件支持的EventType列表

  • 入参类型: 无

  • 返回值:(Array) 支持的EventType列表

  • 注: 目前支持的EventType:timing | scroll | orientation | pan

getComputedStyle(ref)

返回目标视图的相关属性。

  • 入参类型: 接收一个参数,为视图的引用。

  • 入参详细说明:

    • ref: 视图的引用

  • 返回值: Object类型,返回视图的属性集合。属性包括: translateX/translateY/rotateX/rotateY/rotateZ/scaleX/scaleY/opacity/background-color/color