---
name: "offCompassChange"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.3.2" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "offCompassChange - 取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听"
---

## offCompassChange

> [VERSION] BaseKit >= 2.3.2 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听

### 参数

`(listener: Function)`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `listener` | `(params: Object) => void` | 是 | - |  |

##### offCompassChange.listener(params) 的属性

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `direction` | `number` | 是 | - | `2.3.2` | 面对的方向度数 |
| `accuracy` | `string` | 是 | - | `2.3.2` | 精度(iOS与Android平台差异原因，返回有差异) Android：   high 高精度   medium    中等精度   low    低精度   no-contact    不可信，传感器失去连接   unreliable    不可信，原因未知   unknow ${value}    未知的精度枚举值，即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值 iOS：   double类型精度 |


### 示例代码

#### Demo

```tsx
import { onCompassChange, startCompass, offCompassChange } from '@ray-js/ray'

// 取消监听罗盘：先 onCompassChange + startCompass 建立监听，再 offCompassChange 取消
onCompassChange(e => console.log(e));
startCompass({
  success: () => {},
  fail: error => console.error(error),
});
offCompassChange(
  () => console.log("已取消监听罗盘"),
  error => console.error(error)
);
```