地理位置
getLocationInfo
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
const params = {
coordinate:1,
withReGeocode:true
}
window.ksoxz_sdk.getLocationInfo({params, onSuccess, onError})参数说明
| 参数 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| coordinate | number | 否 | 坐标系类型 | 0:wgs84 坐标系 1:gcj02 坐标系 默认为 gcj02 坐标系 |
| withReGeocode | bolean | 否 | 是否需要逆编码信息 | 默认为是 |
| timeout | number | 否 | 定位超时时间,单位:s(秒);默认值为5,(可输入值为3-180);如输入范围值之外的数值,则按accuracy字段自动选择,best模式下10秒,high模式下3秒 | Android端暂不支持该参数 |
| accuracy | string | 否 | 位置的精确度,可选值 high 和 best。默认值为high;当指定为high时,期望精确度为100m;当指定为best时,期望精确度为20m | Android端暂不支持该参数 |
返回结果
| 参数 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| longitude | number | 是 | 经度 | 字符串,按需截取和转换 |
| latitude | number | 是 | 维度 | 字符串,按需截取和转换 |
| address | object | 否 | 逆编码位置信息 | 标准 gps 坐标获取无此字段返回 |
adress:
| 参数 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| description | string | 否 | 地理位置逆编码信息 | 如:湖北省武汉市洪山区雄庄路 100 号光谷 app 广场 2 号楼 |
| provice | string | 否 | 省 | 如:湖北省 |
| city | string | 否 | 城市 | 如:武汉市; 直辖市为空 |
| district | string | 否 | 行政区 | 如:洪山区 |
| road | string | 否 | 街道 | 如:雄庄路 100 号 |
| roadNum | string | 否 | 路牌号 | 如:100 号 |
错误码
| errno | msg | 含义 |
|---|---|---|
| 1002002 | User not granted webApp location permission | 用户未授予网页应用定位权限 |
| 1021002 | GPS permission not obtained | 用户未授予App定位权限 |
| 1022102 | GPS is disabled | GPS未打开 |
startLocationUpdate
startLocationUpdate(Object object) 用于在开启网页应用(在前台时)接收位置更新消息。
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
window.ksoxz_sdk.startLocationUpdate({ params, onSuccess, onError });参数说明
| 参数 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| type | number | 否 | 坐标系类型 | 0:wgs84 坐标系 1:gcj02 坐标系 默认为 gcj02 坐标系 |
错误码
| errno | msg | 含义 |
|---|---|---|
| 1021002 | GPS permission not obtained | 用户未授予 App 定位权限 |
| 1022102 | GPS is disabled | GPS 未打开 |
| 1501001 | continuous location service has started | 持续定位服务已启动 |
stopLocationUpdate
stopLocationUpdate(Object object) 用于关闭监听实时位置变化,停止位置消息接收。
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
window.ksoxz_sdk.stopLocationUpdate({ params, onSuccess, onError });onLocationChange
监听实时地理位置变化事件,需结合 startLocationUpdate 使用。
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
window.ksoxz_sdk.startLocationUpdate({ params, onSuccess, onError })
window.ksoxz_sdk.onLocationChange(callback)返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| latitude | number | 纬度 | 范围为-90~90,正数表示北,负数表示南 |
| longitude | number | 经度 | 范围为-180~180,正数表示东,负数表示西 |
| accuracy | number | 位置的精确度,单位 m | iOS 返回水平精确度与垂直精确度中较大的值 Android 返回水平精确度值 |
| verticalAccuracy | number | 垂直精度,单位 m | 安卓无法获取此值,返回 0 |
| horizontalAccuracy | number | 水平精度,单位 m | / |
| timestamp | number | 定位时间戳,单位 ms | / |
offLocationChange
移除持续定位接口返回失败时触发的监听函数
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
该接口需要与 onLocationChange 接口配套使用。
window.ksoxz_sdk.offLocationChange(callback)