compass

open startSensor stopSensor setDirectionAngle setPointAngle show hide close

概述

指南针控件

接口

open

打开控件

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

params

rect：

  • 类型：JSON对象类型
  • 描述：控件位置
  • 内部字段：
{
     x:,         //数字类型；控件左上角x坐标，默认：0
    y:,        //数字类型；控件左上角y坐标，默认：0
    w:,        //数字类型；控件宽度，默认：299
    h:,        //数字类型；控件高度，默认：299

}

bgStyle：

  • 类型：JSON对象类型
  • 描述：（可选项）背景相关设置
  • 内部字段：
{
    bgColor:'',        //（可选项）字符串类型，背景颜色，支持rgb,rgba，默认：‘#151515’
    strokeColor:'',     //（可选项）字符串类型，边框颜色，支持rgb,rgba，默认：‘#979797’
    strokeWidth:,     //（可选项）数字类型，边框粗细，默认：1
    radius:,       //（可选项）数字类型，边框弯度，默认：16
}

angleTextStyle：

  • 类型：JSON对象类型
  • 描述：（可选项）外环角度文字设置，不设置则不显示
  • 内部字段：
{
    textColor:'',       //（可选项）字符串类型；文字颜色，默认：‘#FFFFFF’
    textSize:,           //（可选项）数字类型；文字大小，默认：12
    rDistance:,        //（可选项）数字类型；文字距离中心距离，默认0.45倍控件宽度
}

scaleStyle：

  • 类型：JSON对象类型
  • 描述：（可选项）刻度相关设置，不设置则不显示
  • 内部字段：
{
    scaleColor:'',        //（可选项）字符串类型；刻度颜色，支持rgb,rgba，默认：‘#979797’
       rDistance:,             //（可选项）数字类型；距离中心点距离，默认：0.3倍控件宽度
    length:,               //（可选项）数字类型；刻度长度，默认：0.05倍控件宽度
}

nsStyle：

  • 类型：JSON对象类型
  • 描述：（可选项）南北相关设置，不设置则不显示
  • 内部字段：
{
    textColor:'',      //（可选项）字符串类型；文字颜色，默认：‘#979797’
    textSize:,       //（可选项）数字类型；文字大小，默认：16
    rDistance:,       //（可选项）数字类型；距离中心距离，默认：0.25倍控件宽度
    nString:'',       //（可选项）字符串类型；北方向文字，默认：‘N’
    sString:'',        //（可选项）字符串类型；南方向文字，默认：‘S’
}

directionStyle：

  • 类型：JSON对象类型
  • 描述：（可选项）方向箭头设置，此方向固定指向北，不设置则不显示
  • 内部字段：
{
    color:'',      //（可选项）字符串类型；箭头颜色，默认：‘#FE0100’
      triangleLen:,   //（可选项）数字类型；箭头顶端三角边长，默认：0.04倍控件宽度
}

pointStyle：

  • 类型：JSON对象类型
  • 描述：（可选项）与正前方角度指针，与正前方固定角度，不设置则不显示
  • 内部字段：
{
    color:'',      //（可选项）字符串类型；指针颜色，默认：‘#0BD956’
      angle:,   //（可选项）数字类型；与正前方向角度，默认：0
}

centerTextStyle：

  • 类型：JSON对象类型
  • 描述：（可选项）中心加角度数显示，不设置则不显示
  • 内部字段：
{
    textColor:'',      //（可选项）字符串类型；文字颜色，默认：‘#F99F00’
      textSize:,   //（可选项）数字类型；文字大小，默认：100
}

autoChange：

  • 类型：布尔类型
  • 描述：（可选项）是否自动跟随方向改变改变
  • 默认：true

interval：

  • 类型：布尔类型
  • 描述：（可选项）刷新频率，当autoChange为true时有效 单位ms
  • 默认：15

fixedOn：

  • 类型：字符串类型
  • 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认：插件依附于当前 window

fixed:

  • 类型：布尔
  • 描述：（可选项）是否将插件视图固定到窗口上（不跟随窗口上下滚动）
  • 默认值：true

callback(ret,err)

ret：

  • 类型：JSON对象类型
  • 描述：正常回调
  • 内部字段
{
status:,     //布尔类型；是否正常返回
eventType:'',     //布尔类型 返回事件
                            ‘show’:显示成功
                            ‘change’:方向变化
angle:,     //数字类型；当前方向角度
pointAngle:,    //数字类型；当前指针角度
}

err：

  • 类型：JSON对象类型
  • 描述：错误回调
  • 内部字段
{
msg:'',        //字符串类型；错误信息
}

示例代码

 var compass = api.require('compass');
            compass.open({
                rect: {
                },
            }, function (ret, err) {
                console.log(JSON.stringify(ret));
               
            });

可用性

Android、iOS系统

可提供的1.0.0及更高版本

startSensor

开始获取方向传感器数据，可单独调用

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

params

autoChange：

  • 类型：布尔类型
  • 描述：（可选项）如果有控件是否跟随数据同步
  • 默认值：控件当前状态

interval：

  • 类型：布尔类型
  • 描述：（可选项）控件刷新频率（非返回频率），当autoChange为true时有效 单位ms
  • 默认：15

callback(ret,err)

ret：

  • 类型：JSON对象类型
  • 描述：正常回调
  • 内部字段
{
angle:,     //数字类型；当前方向角度
}

err：

  • 类型：JSON对象类型
  • 描述：错误回调
  • 内部字段
{
msg:'',        //字符串类型；错误信息
}

示例代码

 var compass = api.require('compass');
            compass.startSensor({
            }, function (ret, err) {
                console.log(JSON.stringify(ret));
               
            });

可用性

Android、iOS系统

可提供的1.0.0及更高版本

stopSensor

停止传感器

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

callback(ret,err)

ret：

  • 类型：JSON对象类型
  • 描述：正常回调
  • 内部字段
{
status:,     //布尔类型，是否成功
}

err：

  • 类型：JSON对象类型
  • 描述：错误回调
  • 内部字段
{
msg:'',        //字符串类型；错误信息
}

示例代码

 var compass = api.require('compass');
            compass.stopSensor({
            }, function (ret, err) {
                console.log(JSON.stringify(ret));
               
            });

可用性

Android、iOS系统

可提供的1.0.0及更高版本

setDirectionAngle

控件设置方向，可配合autoChange为false时使用

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

params

angle：

  • 类型：数字类型
  • 描述：（可选项）方向
  • 取值范围[0-359]
  • 默认值：0

示例代码

 var compass = api.require('compass');
            compass.setDirectionAngle({
                angle:,
            }, function (ret, err) {
                console.log(JSON.stringify(ret));
               
            });

可用性

Android、iOS系统

可提供的1.0.0及更高版本

setPointAngle

设置指针角度，需要已经支持指针显示

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

params

angle：

  • 类型：数字类型
  • 描述：指针角度
  • 取值范围：[0-359]

示例代码

 var compass = api.require('compass');
            compass.setPointAngle();

可用性

Android、iOS系统

可提供的1.0.0及更高版本

show

显示

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

示例代码

 var compass = api.require('compass');
            compass.show();

可用性

Android、iOS系统

可提供的1.0.0及更高版本

hide

隐藏

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

示例代码

 var compass = api.require('compass');
            compass.hide();

可用性

Android、iOS系统

可提供的1.0.0及更高版本

close

关闭

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

示例代码

 var compass = api.require('compass');
            compass.close();

可用性

Android、iOS系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24