开发 API 位置 ks.getLocation
# ks.getLocation
更新时间:2024-09-19 14:44:22
获取当前地理位置信息。调用前需要 用户授权 scope.userLocation
。
# getLocation(options: GetLocationOptions): Promise<LocationInfo>
# 参数
参数 | 类型 | 必填 |
---|---|---|
options | GetLocationOptions | 是 |
# GetLocationOptions
属性
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
type | 'wgs84' | 'gcj02' | 'wgs84' | 否 | 坐标类型 |
altitude | boolean | false | 否 | 是否获取高度信息。获取高度信息时,需要较高精度,接口耗时会增加 |
isHighAccuracy | boolean | false | 否 | 是否开启高精度定位。开启高精度定位后,接口耗时会增加 |
highAccuracyExpireTime | number | 否 | 开启高精度定位后,接口的超时时间 (ms)。接口在超时时间内返回获取的最高精度地理位置信息。该值在 3000 (ms) 以上时,高精度定位才有效果 | |
success | (result: LocationInfo) => void | 否 | 接口调用成功的回调函数 | |
fail | (error: APIError) => void | 否 | 接口调用失败的回调函数 | |
complete | (resultOrError: LocationInfo | APIError) => void | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
# 返回值
# Promise<LocationInfo>
LocationInfo
属性
属性 | 类型 | 说明 |
---|---|---|
latitude | number | 纬度,范围 [-90, 90],负数表示南纬 |
longitude | number | 经度,范围 [-180, 180],负数表示西经 |
speed | number | 速度 (m/s) |
accuracy | number | 位置的精确度 |
altitude | number | 高度 (m) |
verticalAccuracy | number | 垂直精度 (m)(Android 无法获取,返回 0) |
horizontalAccuracy | number | 水平精度 (m) |
# 错误信息
错误信息 | 错误说明 |
---|---|
no permission | 无定位权限 |
not authorize | 未授权 |
# 扫码体验
# 示例代码
上一篇:《SelectorQuery.selectViewport》
下一篇:《ks.onLocationChange》
仍有疑问? 前往社区提问