简体中文
简体中文
# uni.onLocationChange(callback)
监听实时地理位置变化事件
# onLocationChange 兼容性
| Web | 微信小程序 | Android | iOS | HarmonyOS |
|---|---|---|---|---|
| 4.0 | 4.41 | 4.81 | 4.81 | 4.81 |
# 参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| listener | (res: GetLocationSuccess) => void | 是 | - | - |
# GetLocationSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| latitude | number | 是 | 0 | 纬度，浮点数，范围为-90~90，负数表示南纬 | |
| longitude | number | 是 | 0 | 经度，范围为-180~180，负数表示西经 | |
| speed | number | 是 | 0 | 速度，浮点数，单位m/s | |
| accuracy | number | 是 | - | 位置的精确度 | |
| altitude | number | 是 | 0 | 高度，单位 m | |
| verticalAccuracy | number | 是 | 0 | 垂直精度，单位 m（Android 无法获取，返回 0） | |
| horizontalAccuracy | number | 是 | 0 | 水平精度，单位 m（Android、HarmonyOS 无法获取，返回 0） | |
| address | string | 否 | null | 地址信息 |
# 返回值
| 类型 |
|---|
| number |
# 参见
# uni.offLocationChange(callback)
移除实时地理位置变化事件。
# offLocationChange 兼容性
| Web | 微信小程序 | Android | iOS | HarmonyOS |
|---|---|---|---|---|
| 4.0 | 4.41 | 4.81 | 4.81 | 4.81 |
# 参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| listener | number | (res: GetLocationSuccess) => void | 否 | - | - |
# GetLocationSuccess 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| latitude | number | 是 | 0 | 纬度，浮点数，范围为-90~90，负数表示南纬 | |
| longitude | number | 是 | 0 | 经度，范围为-180~180，负数表示西经 | |
| speed | number | 是 | 0 | 速度，浮点数，单位m/s | |
| accuracy | number | 是 | - | 位置的精确度 | |
| altitude | number | 是 | 0 | 高度，单位 m | |
| verticalAccuracy | number | 是 | 0 | 垂直精度，单位 m（Android 无法获取，返回 0） | |
| horizontalAccuracy | number | 是 | 0 | 水平精度，单位 m（Android、HarmonyOS 无法获取，返回 0） | |
| address | string | 否 | null | 地址信息 |
# 参见
# uni.onLocationChangeError(callback)
监听持续定位接口返回失败时触发。
# onLocationChangeError 兼容性
| Web | 微信小程序 | Android | iOS | HarmonyOS |
|---|---|---|---|---|
| 4.0 | 4.41 | 4.81 | 4.81 | 4.81 |
# 参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| listener | (res: UniError) => void | 是 | - | - |
# 返回值
| 类型 |
|---|
| number |
# 参见
# uni.offLocationChangeError(callback)
移除监听持续定位接口返回失败事件。
# offLocationChangeError 兼容性
| Web | 微信小程序 | Android | iOS | HarmonyOS |
|---|---|---|---|---|
| 4.0 | 4.41 | 4.81 | 4.81 | 4.81 |
# 参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| listener | number | (res: UniError) => void | 否 | - | - |
# 参见
# uni.startLocationUpdate(options)
开启应用进入前台时接收位置消息。
# startLocationUpdate 兼容性
| Web | 微信小程序 | Android | iOS | HarmonyOS |
|---|---|---|---|---|
| 4.0 | 4.41 | 4.81 | 4.81 | 4.81 |
# 参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 | |||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| options | StartLocationUpdateOptions | 是 | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
# IGetLocationFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| errCode | number | 是 | - | - | 错误码 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | any | 否 | - | - | 错误信息中包含的数据 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cause | Error | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| errMsg | string | 是 | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
# 参见
# uni.stopLocationUpdate(options)
关闭监听实时位置变化，前后台都停止消息接收。
# stopLocationUpdate 兼容性
| Web | 微信小程序 | Android | iOS | HarmonyOS |
|---|---|---|---|---|
| 4.0 | 4.41 | 4.81 | 4.81 | 4.81 |
# 参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| options | StopLocationUpdateOptions | 是 | - | - | |||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
# IGetLocationFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| errCode | number | 是 | - | - | 错误码 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | any | 否 | - | - | 错误信息中包含的数据 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cause | Error | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| errMsg | string | 是 | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
# 参见
# uni.startLocationUpdateBackground(option)
# 注意
- iOS平台：如果应用需要后台定位能力，需要在 info.plist 中配置 UIBackgroundModes 的 location，注意需Xcode工程中添加相对应 Capabilities 中的 Background Modes，并且勾选 Location updates。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<key>UIBackgroundModes</key>
<array>
<string>location</string>
</array>
</dict>
</plist>
开始监听实时地理位置信息变化事件，应用进入前后台时均接收实时地理位置信息。
# startLocationUpdateBackground 兼容性
| Web | 微信小程序 | Android | iOS | HarmonyOS |
|---|---|---|---|---|
| 4.0 | 4.41 | 4.81 | 4.81 | 4.81 |
# 参数
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 | |||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| options | StartLocationUpdateBackgroundOptions | 是 | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
# IGetLocationFail 的属性值
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| errCode | number | 是 | - | - | 错误码 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| errSubject | string | 是 | - | - | 统一错误主题（模块）名称 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| data | any | 否 | - | - | 错误信息中包含的数据 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cause | Error | 否 | - | - | 源错误信息，可以包含多个错误，详见SourceError | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| errMsg | string | 是 | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
# 参见
# 示例
示例为hello uni-app x alpha分支，与最新HBuilderX Alpha版同步。与最新正式版同步的master分支示例另见
示例
<template>
<!-- #ifdef APP -->
<text>显示简易操作日志(可滚动查看)</text><button size="mini" @click="log=''">清空日志</button>
<scroll-view style="max-height: 300px;">
<text style="margin: 2px; padding: 2px; border: 1px solid #000000;">{{ log }}</text>
</scroll-view>
<view class="uni-list">
<text style="margin-bottom: 4px"> 请选择定位服务提供商：</text>
<radio-group class="uni-flex uni-row" @change="providerChange" style="flex-wrap: wrap">
<radio class="uni-list-cell" style="margin-right: 15px" v-for="(item, index) in providerList" :key="item.id"
:value="item.id" :checked="index === currentSelectedProvider">
{{ item.name }}
</radio>
</radio-group>
</view>
<view class="uni-list">
<text style="margin-bottom: 4px"> 请选择坐标系：</text>
<radio-group class="uni-flex uni-row" @change="typeChange" style="flex-wrap: wrap">
<radio class="uni-list-cell" style="margin-right: 15px" v-for="(item, index) in types" :key="item.value"
:value="item.value" :checked="index === currentSelectedType">
{{ item.name }}
</radio>
</radio-group>
</view>
<scroll-view style="flex:1">
<!-- #endif -->
<button class="btnstyle" type="primary" @tap="startLocationUpdate" id="startLocationUpdate">点击连续定位</button>
<button class="btnstyle" type="primary" @tap="startLocationUpdateBackground"
id="startLocationUpdateBackground">后台点击连续定位</button>
<button class="btnstyle" type="primary" @tap="stopLocationUpdate" id="stopLocationUpdate">点击关闭定位</button>
<button class="btnstyle" type="primary" @tap="onLocationChange" id="onLocationChange">onLocationChange</button>
<button class="btnstyle" type="primary" @tap="offLocationChange" id="offLocationChange">offLocationChange</button>
<button class="btnstyle" type="primary" @tap="onLocationChangeError"
id="onLocationChangeError">onLocationChangeError</button>
<button class="btnstyle" type="primary" @tap="offLocationChangeError"
id="offLocationChangeError">offLocationChangeError</button>
<!-- #ifdef APP -->
</scroll-view>
<!-- #endif -->
</template>
<script>
type LocationType = 'wgs84' | 'gcj02'
export type ItemType = { value : LocationType, name : LocationType }
export type LocationItem = { id : string, name : string, provider ?: UniProvider }
export default {
data() {
return {
log: "",
logAble: true,
providerList: [] as LocationItem[],
types: [
{
value: 'wgs84',
name: 'wgs84'
},
{
value: 'gcj02',
name: 'gcj02'
}
] as ItemType[],
currentSelectedProvider: 0,
currentSelectedType: 0,
startSuccess: false,
stopSuccess: false,
errCode: 0
}
},
onLoad: function () {
// #ifdef APP
this.getProvider()
// #endif
},
onUnload() {
uni.stopLocationUpdate({})
uni.offLocationChange(null)
uni.offLocationChangeError(null)
},
methods: {
getProvider() {
// #ifdef APP
let provider = uni.getProviderSync({
service: "location",
} as GetProviderSyncOptions)
console.log(provider)
provider.providerObjects.forEach((value : UniProvider) => {
var currentProvider = value
this.providerList.push({
name: currentProvider.description,
id: currentProvider.id,
provider: currentProvider
} as LocationItem);
})
this.providerList.forEach((value, index) => {
if (value.id == "system") {
this.currentSelectedProvider = index
}
})
// #endif
},
providerChange(e : UniRadioGroupChangeEvent) {
for (let i = 0; i < this.providerList.length; i++) {
if (this.providerList[i].id === e.detail.value) {
this.currentSelectedProvider = i;
break;
}
}
if (e.detail.value == "system") {
this.currentSelectedType = 0
} else if (e.detail.value == "tencent") {
this.currentSelectedType = 1
}
},
typeChange(e : UniRadioGroupChangeEvent) {
for (let i = 0; i < this.types.length; i++) {
if (this.types[i].value === e.detail.value) {
this.currentSelectedType = i;
break;
}
}
},
offLocationChangeError() {
if (this.logAble) {
this.log += "关闭offLocationChangeError监听" + '\n\n'
}
console.log("关闭onLocationChangeError监听")
uni.offLocationChangeError(null)
},
onLocationChangeError() {
uni.offLocationChangeError(null)
if (this.logAble) {
this.log += "开启onLocationChangeError监听" + '\n\n'
}
console.log("开启onLocationChangeError监听")
uni.onLocationChangeError((e) => {
console.log("onLocationChangeError回调: ", e)
if (this.logAble) {
this.log += JSON.stringify(e) + '\n\n'
}
})
},
onLocationChange() {
uni.offLocationChange(null)
console.log("开启onLocationChange监听")
if (this.logAble) {
this.log += "开启onLocationChange监听" + '\n\n'
}
uni.onLocationChange((e) => {
console.log("onLocationChange持续监听回调: ", e)
if (this.logAble) {
this.log += "provider= " + this.providerList[this.currentSelectedProvider].id + '\n' + JSON.stringify(e) + '\n\n'
}
})
},
offLocationChange() {
if (this.logAble) {
this.log += "关闭offLocationChange监听" + '\n\n'
}
console.log("关闭offLocationChange监听")
uni.offLocationChange(null)
},
startLocationUpdate() {
// #ifdef APP
if (this.providerList.length == 0) {
uni.showToast({
title: '未获取到provider，请确定基座中包含location功能',
icon: "error"
})
console.log("未获取到provider，请确定基座中包含location功能")
return
}
// #endif
uni.startLocationUpdate({
provider: this.providerList[this.currentSelectedProvider].id,
type: this.types[this.currentSelectedType].value,
success: () => {
if (this.logAble) {
this.log += "开启startLocationUpdate成功, provider= " + this.providerList[this.currentSelectedProvider].id + '\n\n'
}
console.log("持续定位启动成功")
this.startSuccess = true
},
fail: (err) => {
if (this.logAble) {
this.log += "启动startLocationUpdate失败：erroCode=" + err.errCode + '\n\n'
}
console.log("持续定位启动失败")
this.startSuccess = false
this.errCode = err.errCode
}
})
},
startLocationUpdateBackground() {
// #ifdef APP
if (this.providerList.length == 0) {
uni.showToast({
title: '未获取到provider，请确定基座中包含location功能',
icon: "error"
})
console.log("未获取到provider，请确定基座中包含location功能")
return
}
// #endif
uni.startLocationUpdateBackground({
provider: this.providerList[this.currentSelectedProvider].id,
type: this.types[this.currentSelectedType].value,
success: () => {
if (this.logAble) {
this.log += "开启startLocationUpdateBackground成功, provider= " + this.providerList[this.currentSelectedProvider].id + '\n\n'
}
console.log("后台持续定位api启动成功")
this.startSuccess = true
}, fail: (err) => {
if (this.logAble) {
this.log += "启动startLocationUpdateBackground失败：erroCode=" + err.errCode + '\n\n'
}
console.log("后台持续定位启动失败")
this.startSuccess = false
this.errCode = err.errCode
}
})
},
stopLocationUpdate() {
uni.stopLocationUpdate({
success: () => {
if (this.logAble) {
this.log += "成功关闭stopLocationUpdate定位" + '\n\n'
}
console.log("成功关闭stopLocationUpdate定位")
this.stopSuccess = true
}
})
}
}
}
</script>
<style>
.uni-list {
border-bottom: 0px;
background-color: transparent;
margin-left: 10px;
margin-right: 10px;
margin-top: 4px;
margin-bottom: 4px;
}
.uni-list-cell {
position: relative;
display: flex;
flex-direction: row;
justify-content: space-between;
align-items: center;
}
.btnstyle {
margin: 4px;
}
</style>
# 通用类型
# GeneralCallbackResult
| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
|---|---|---|---|---|---|
| errMsg | string | 是 | - | 错误信息 |
