uni-app
uni-app x
uniCloud
HBuilder X
uni 小程序 sdk
uni-ad广告
开发者服务
uni-app
uni-app x
uniCloud
HBuilder X
uni 小程序 sdk
uni-ad广告
开发者服务
uni-app x
简体中文
GitHub
API
uni.onCompassChange(callback)
onCompassChange 兼容性
参数
OnCompassChangeSuccess 的属性值
参见
uni.offCompassChange(callback)
offCompassChange 兼容性
参数
OnCompassChangeSuccess 的属性值
参见
展示全部

# uni.onCompassChange(callback)

监听罗盘数据变化事件。频率：5 次/秒，接口调用后会自动开始监听

# onCompassChange 兼容性

Web 微信小程序 Android iOS HarmonyOS HarmonyOS(Vapor)
4.0 4.41 5.08 5.08 5.08 5.08

App平台另见 https://gitcode.com/dcloud/utsPlugIn/

# 参数

名称 类型 必填 默认值 兼容性 描述
callback (result: OnCompassChangeSuccess) => void 是 -
-

# OnCompassChangeSuccess 的属性值

名称 类型 必备 默认值 兼容性 描述
direction number 是 -
-
accuracy number | string 否 -
-
errMsg string 否 -
-

# 参见

# uni.offCompassChange(callback)

取消监听罗盘数据

# offCompassChange 兼容性

Web 微信小程序 Android iOS HarmonyOS HarmonyOS(Vapor)
4.0 4.41 5.08 5.08 5.08 5.08

App平台另见 https://gitcode.com/dcloud/utsPlugIn/

# 参数

名称 类型 必填 默认值 兼容性 描述
callback (result: OnCompassChangeSuccess) => void 是 -
-
-

# OnCompassChangeSuccess 的属性值

名称 类型 必备 默认值 兼容性 描述
direction number 是 -
-
accuracy number | string 否 -
-
errMsg string 否 -
-

# 参见

# uni.startCompass(options?)

开始监听罗盘数据

# startCompass 兼容性

Web 微信小程序 Android iOS HarmonyOS HarmonyOS(Vapor)
4.0 4.41 5.08 5.08 5.08 5.08

App平台另见 https://gitcode.com/dcloud/utsPlugIn/

# 参数

名称 类型 必填 默认值 兼容性 描述
options StartCompassOptions 否 -
-
名称 类型 必备 默认值 兼容性 描述
success (res: CompassSuccess) => void 否 -
-
fail (res: CompassFail) => void 否 -
-
complete (res: string) => void 否 -
-

# CompassSuccess 的属性值

名称 类型 必备 默认值 兼容性 描述
errMsg string 否 -
-

# CompassFail 的属性值

名称 类型 必备 默认值 兼容性 描述
errCode number 是 -
-
合法值 兼容性 描述
501
-
-
502
-
-
503
-
-
504
-
-
601
-
-
602
-
-
603
-
-
604
-
-
701
-
-
702
-
-
703
-
-
704
-
-
801
-
-
802
-
-
803
-
-
804
-
-
901
-
-
errSubject string 是 -
-
统一错误主题（模块）名称
data any 否 -
-
错误信息中包含的数据
cause Error 否 - - 源错误信息，可以包含多个错误，详见SourceError
errMsg string 是 -
-

# 的属性值

合法值 兼容性 描述
interface
-
-
interface
-
-

# 参见

# uni.stopCompass(options?)

停止监听罗盘数据

# stopCompass 兼容性

Web 微信小程序 Android iOS HarmonyOS HarmonyOS(Vapor)
4.0 4.41 5.08 5.08 5.08 5.08

App平台另见 https://gitcode.com/dcloud/utsPlugIn/

# 参数

名称 类型 必填 默认值 兼容性 描述
options StopCompassOptions 否 -
-
名称 类型 必备 默认值 兼容性 描述
success (res: CompassSuccess) => void 否 -
-
fail (res: CompassFail) => void 否 -
-
complete (res: string) => void 否 -
-

# CompassSuccess 的属性值

名称 类型 必备 默认值 兼容性 描述
errMsg string 否 -
-

# CompassFail 的属性值

名称 类型 必备 默认值 兼容性 描述
errCode number 是 -
-
合法值 兼容性 描述
501
-
-
502
-
-
503
-
-
504
-
-
601
-
-
602
-
-
603
-
-
604
-
-
701
-
-
702
-
-
703
-
-
704
-
-
801
-
-
802
-
-
803
-
-
804
-
-
901
-
-
errSubject string 是 -
-
统一错误主题（模块）名称
data any 否 -
-
错误信息中包含的数据
cause Error 否 - - 源错误信息，可以包含多个错误，详见SourceError
errMsg string 是 -
-

# 的属性值

合法值 兼容性 描述
interface
-
-
interface
-
-

# 参见

# 示例

示例为hello uni-app x alpha分支，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例另见

示例

<template>
  <view>
    <page-head :title="title"></page-head>
    <view class="uni-padding-wrap">
      <view class="uni-hello-text uni-center" style="padding-bottom:25px;">
        旋转手机即可获取方位信息
      </view>
      <view class="direction">
        <view class="bg-compass-line"></view>
        <image class="bg-compass" src="../../../static/compass.png" :style="'transform: rotate('+direction+'deg)'">
        </image>
        <view class="direction-value">
          <text>{{direction}}</text>
          <text class="direction-degree">o</text>
        </view>
      </view>
    </view>
  </view>
</template>
<script setup lang="uts">
  const title = ref('onCompassChange')
  const direction = ref(0)

  onReady(() => {
    uni.onCompassChange((res) => {
      console.log('onCompassChange', res)
      direction.value = res.direction
    })
  })

  onUnload(() => {
    uni.stopCompass();
    direction.value = 0;
  })

</script>

<style>
  .direction {
    position: relative;
    margin-top: 35px;
    display: flex;
    width: 270px;
    height: 270px;
    align-items: center;
    justify-content: center;
    margin: 0 auto;
  }

  .direction-value {
    position: relative;
    font-size: 100px;
    color: #353535;
    line-height: 1;
    z-index: 1;
  }

  .direction-degree {
    position: absolute;
    top: 0;
    right: -20px;
    font-size: 30px;
  }

  .bg-compass {
    position: absolute;
    top: 0;
    left: 0;
    width: 270px;
    height: 270px;
    transition: .1s;
  }

  .bg-compass-line {
    position: absolute;
    left: 134px;
    top: -5px;
    width: 3px;
    height: 28px;
    background-color: #1AAD19;
    border-radius: 100px;
    z-index: 1;
  }
</style>

# 通用类型

# GeneralCallbackResult

名称 类型 必备 默认值 兼容性 描述
errMsg string 是 -
错误信息
本页导读
uni.onCompassChange(callback)
onCompassChange 兼容性
参数
OnCompassChangeSuccess 的属性值
参见
uni.offCompassChange(callback)
offCompassChange 兼容性
参数
OnCompassChangeSuccess 的属性值
参见
uni.startCompass(options?)
startCompass 兼容性
参数
CompassSuccess 的属性值
CompassFail 的属性值
的属性值
参见
uni.stopCompass(options?)
stopCompass 兼容性
参数
CompassSuccess 的属性值
CompassFail 的属性值
的属性值
参见
示例
通用类型
GeneralCallbackResult
uni-agent