ruler

来自于:开发者立即使用

openRuler hideRuler showRuler closeRuler

论坛示例

为帮助用户更好更快的使用模块,论坛维护了一个示例,示例中包含示例代码供您参考。

概述

ruler 模块概述

本模块封装了iOS和Android下尺子UI的功能,方便实现一些拖动刻度的功能(备注:iOS和Android的UI效果有差异)。

固件要求

Android:4.1及以上 iOS:8.0及以上

模块接口

openRuler

打开尺子

openRuler({params}, callback(ret))

params

rect:

  • 类型:JSON 对象
  • 描述:(必填项)模块的位置及尺寸
  • 备注:iOS,Android 必须传此参数。
  • 内部字段:
  1. {
  2. x: 0, //(必填项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
  3. y: 0, //(必填项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
  4. w: 320, //(必填项)数字类型;模块的宽度;默认值:所属的 Window 或 Frame 的宽度
  5. h: 150 //(可选项)数字类型;模块的高度;默认值:150(该值不能太小,否则刻度不能正常显示,请开发者自行控制)
  6. }

fixedOn:

  • 类型:字符串
  • 描述:(可选项)模块所属 Frame 的名字,若不传则模块归属于当前 Window

fixed:

  • 类型:布尔
  • 描述:(可选项)模块是否随所属 Window 或 Frame 滚动
  • 默认值:true(不随之滚动)

rulerCount:

  • 类型:数字型
  • 描述:(可选项)尺子的总刻度
  • 默认值:20

currentValue:

  • 类型:数字型
  • 描述:(可选项)尺子的当前刻度值
  • 默认值:16

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true, //布尔型;true
  3. rulerValue : 15, //滑动选中的刻度值
  4. index : 0, //当前打开刻度尺视图序号
  5. }

示例代码

  1. var demo = api.require('ruler');
  2. demo.openRuler({
  3. rect : {
  4. x : 0,
  5. y : 300,
  6. w : 300,
  7. },
  8. rulerCount : 200,
  9. currentValue : 150,
  10. fixedOn : api.frameName,
  11. fixed : true
  12. },function(ret, err){ api.toast({ msg:JSON.stringify(ret) });
  13. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hideRuler

隐藏尺子

hideRuler({params}, callback(ret, err))

params

index:

  • 类型:数字型
  • 描述:(可选项)刻度尺视图序号
  • 默认值:0

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. status: true //布尔型;true||false
  3. }

err:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. msg: ""
  3. }

示例代码

  1. var demo = api.require('ruler');
  2. demo.hideRuler(function(ret,err){api.toast({ msg:JSON.stringify(ret) });});

可用性

Android、iOS系统

可提供的1.0.0及更高版本

showRuler

显示尺子

showRuler({params}, callback(ret, err))

params

index:

  • 类型:数字型
  • 描述:(可选项)刻度尺视图序号
  • 默认值:0

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. status: true //布尔型;true||false
  3. }

err:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. msg: ""
  3. }

示例代码

  1. var demo = api.require('ruler');
  2. demo.showRuler(function(ret,err){api.toast({ msg:JSON.stringify(ret) });});

可用性

Android、iOS系统

可提供的1.0.0及更高版本

closeRuler

关闭尺子

closeRuler({params}, callback(ret, err))

params

index:

  • 类型:数字型
  • 描述:(可选项)刻度尺视图序号
  • 默认值:0

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. status: true //布尔型;true||false
  3. }

err:

  • 类型:JSON对象
  • 内部字段:
  1. {
  2. msg: ""
  3. }

示例代码

  1. var demo = api.require('ruler');
  2. demo.closeRuler(function(ret,err){api.toast({ msg:JSON.stringify(ret) });});

可用性

Android、iOS系统

可提供的1.0.0及更高版本