uni.onCompassChange(callback)
监听罗盘数据
onCompassChange 兼容性
Web | 微信小程序 | Android | iOS | HarmonyOS |
4.0 | 4.41 | x | x | x |
参数
名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
callback | (result: OnCompassChangeSuccess) => void | 是 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| |
OnCompassChangeSuccess 的属性值
名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
direction | number | 是 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 面对的方向度数 |
accuracy | any | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 需要基础库: 2.4.0
精度
|
errMsg | string | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 错误信息
|
参见
uni.offCompassChange(callback)
取消监听罗盘数据
offCompassChange 兼容性
Web | 微信小程序 | Android | iOS | HarmonyOS |
4.0 | 4.41 | x | x | x |
参数
名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
callback | (result: OnCompassChangeSuccess) => void | 是 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| - |
OnCompassChangeSuccess 的属性值
名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
direction | number | 是 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 面对的方向度数 |
accuracy | any | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 需要基础库: 2.4.0
精度
|
errMsg | string | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 错误信息
|
参见
uni.startCompass(options?)
开始监听罗盘数据
startCompass 兼容性
Web | 微信小程序 | Android | iOS | HarmonyOS |
4.0 | 4.41 | x | x | x |
参数
名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
options | StartCompassOptions | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| |
名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | success | (res: CompassSuccess) => void | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| uni.startCompass成功回调函数定义 | fail | (res: ICompassError) => void | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| uni.startCompass失败回调函数定义 | complete | (res: any) => void | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| uni.startCompass完成回调函数定义 |
|
CompassSuccess 的属性值
名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
errMsg | string | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 错误信息
|
ICompassError 的属性值
名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
errCode | number | 是 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| |
errMsg | string | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 错误信息
|
errSubject | string | 是 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| 统一错误主题(模块)名称 |
data | any | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| 错误信息中包含的数据 |
cause | Error | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| 源错误信息,可以包含多个错误,详见SourceError |
参见
uni.stopCompass(options?)
停止监听罗盘数据
stopCompass 兼容性
Web | 微信小程序 | Android | iOS | HarmonyOS |
4.0 | 4.41 | x | x | x |
参数
名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
options | StopCompassOptions | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| |
名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | success | (res: CompassSuccess) => void | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 成功返回的回调函数 | fail | (res: ICompassError) => void | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 失败的回调函数 | complete | (res: any) => void | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 结束的回调函数(调用成功、失败都会执行) |
|
CompassSuccess 的属性值
名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
errMsg | string | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 错误信息
|
ICompassError 的属性值
名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
errCode | number | 是 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| |
errMsg | string | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | x | x | x |
| 错误信息
|
errSubject | string | 是 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| 统一错误主题(模块)名称 |
data | any | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| 错误信息中包含的数据 |
cause | Error | 否 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | - | x | x | x |
| 源错误信息,可以包含多个错误,详见SourceError |
参见
示例
示例为 alpha 分支:hello uni-app x(alpha)
master 分支:hello uni-app x(master)
通用类型
GeneralCallbackResult
名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
errMsg | string | 是 | - |
Web
|
微信小程序
|
Android
|
iOS
|
HarmonyOS
| - | 4.41 | - | - | - |
| 错误信息 |