方法:
对象:
回调方法:
权限:
5+功能模块(permissions)
getCurrentPosition
获取当前设备位置信息
说明:
位置信息将通过手机GPS设备或其它信息如IP地址、移动网络信号获取,由于获取位置信息可能需要较长的时间,当成功获取位置信息后将通过successCB回调函数返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持) :
支持
- iOS - 4.3+ (支持) :
支持
示例:
uni-app使用plus注意事项
watchPosition
监听设备位置变化信息
说明:
位置信息将通过手机GPS设备或其它信息如IP地址、移动网络信号获取。 当位置信息更新后将通过successCB回调函数返回。 位置信息获取失败则调用回调函数errorCB。
参数:
返回值:
Number : 用于标识位置信息监听器,可通过clearWatch方法取消监听。
平台支持:
- Android - 2.2+ (支持) :
支持
- iOS - 4.3+ (支持) :
支持
示例:
uni-app使用plus注意事项
clearWatch
关闭监听设备位置信息
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持) :
支持
- iOS - 4.3+ (支持) :
支持
示例:
uni-app使用plus注意事项
Position
JSON对象,设备位置信息数据
属性:
- coords: (Coordinates 类型 )地理坐标信息,包括经纬度、海拔、速度等信息
- coordsType: (String 类型 )获取到地理坐标信息的坐标系类型
可取以下坐标系类型: "wgs84":表示WGS-84坐标系; "gcj02":表示国测局经纬度坐标系; "bd09":表示百度墨卡托坐标系,仅百度定位支持; "bd09ll":表示百度经纬度坐标系,仅百度定位支持。
- timestamp: (Number 类型 )获取到地理坐标的时间戳信息
时间戳值为从1970年1月1日至今的毫秒数。
- address: (Address 类型 )获取到地理位置对应的地址信息
获取地址信息需要连接到服务器进行解析,所以会消耗更多的资源,如果不需要获取地址信息可通过设置PositionOptions参数的geocode属性值为false避免获取地址信息。 如果没有获取到地址信息则返回undefined。
平台支持
- Android - 2.3+ (支持) :
使用系统定位模块无法获取位置信息。
- iOS - 5.1+ (支持) :
系统定位模块也支持获取位置信息。
- addresses: (String 类型 )获取完整地址描述信息
如果没有获取到地址信息则返回undefined。
平台支持
- Android - 2.3+ (支持) :
使用系统定位模块无法获取位置信息。
- iOS - 5.1+ (支持) :
系统定位模块也支持获取位置信息。
Address
JSON对象,地址信息
属性:
- country: (String 类型 )国家
如“中国”,如果无法获取此信息则返回undefined。
- province: (String 类型 )省份名称
如“北京市”,如果无法获取此信息则返回undefined。
- city: (String 类型 )城市名称
如“北京市”,如果无法获取此信息则返回undefined。
- district: (String 类型 )区(县)名称
如“朝阳区”,如果无法获取此信息则返回undefined。
- street: (String 类型 )街道信息
如“酒仙桥路”,如果无法获取此信息则返回undefined。
- streetNum: (String 类型 )获取街道门牌号信息
如“3号”,如果无法获取此信息则返回undefined。
- poiName: (String 类型 )POI信息
如“电子城.国际电子总部”,如果无法获取此信息则返回undefined。
- postalCode: (String 类型 )邮政编码
如“100016”,如果无法获取此信息则返回undefined。
- cityCode: (String 类型 )城市代码
如“010”,如果无法获取此信息则返回undefined。
Coordinates
JSON对象,地理坐标信息
属性:
- latitude: (Number 类型 )坐标纬度值
数据类型对象,地理坐标中的纬度值。
- longitude: (Number 类型 )坐标经度值
数据类型对象,地理坐标中的经度值。
- altitude: (Number 类型 )海拔信息
数据类型对象,如果无法获取此信息,则此值为空(null)。
- accuracy: (Number 类型 )地理坐标信息的精确度信息
数据类型对象,单位为米,其有效值必须大于0。
- altitudeAccuracy: (Number 类型 )海拔的精确度信息
数据类型对象,单位为米,其有效值必须大于0。如果无法获取海拔信息,则此值为空(null)。
- heading: (Number 类型 )表示设备移动的方向
数据类型对象,范围为0到360,表示相对于正北方向的角度。如果无法获取此信息,则此值为空(null)。如果设备没有移动则此值为NaN。
- speed: (Number 类型 )表示设备移动的速度
数据类型对象,单位为米每秒(m/s),其有效值必须大于0。如果无法获取速度信息,则此值为空(null)。
PositionOptions
JSON对象,监听设备位置信息参数
属性:
- enableHighAccuracy: (Boolean 类型 )是否高精确度获取位置信息
高精度获取表示需要使用更多的系统资源,默认值为false。
- timeout: (Number 类型 )获取位置信息的超时时间
单位为毫秒(ms),默认值为不超时。如果在指定的时间内没有获取到位置信息则触发错误回调函数。
- maximumAge: (Number 类型 )获取位置信息的间隔时间
单位为毫秒(ms),默认值为1000(即1秒)。调用plus.geolocation.watchPosition时为更新位置信息的间隔时间。 注意:在不同定位模块下支持范围值可能不同,如百度定位模块的间隔范围为大于等于1秒,如果设置的值小于最小值则使用最小值。
- provider: (String 类型 )优先使用的定位模块
可取以下供应者: "system":表示系统定位模块,支持wgs84坐标系; "baidu":表示百度定位模块,支持gcj02/bd09/bd09ll坐标系; "amap":表示高德定位模块,支持gcj02坐标系。 默认值按以下优先顺序获取(amap>baidu>system),若指定的provider不存在或无效则返回错误回调。 注意:百度/高德定位模块需要配置百度/高德地图相关参数才能正常使用。
平台支持
- coordsType: (String 类型 )指定获取的定位数据坐标系类型
可取以下坐标系类型: "wgs84":表示WGS-84坐标系; "gcj02":表示国测局经纬度坐标系; "bd09":表示百度墨卡托坐标系; "bd09ll":表示百度经纬度坐标系; provider为"system"时,支持wgs84坐标系,默认使用"wgs84"坐标系; provider为"baidu"时,支持gcj02/bd09/bd09ll坐标系,默认使用"gcj02"坐标系; provider为"amap"时,支持gcj02坐标系,默认使用"gcj02"坐标系。 如果设置的坐标系类型provider不支持,则返回错误。
- geocode: (Boolean 类型 )是否解析地址信息
解析的地址信息保存到Position对象的address、addresses属性中,true表示解析地址信息,false表示不解析地址信息,返回的Position对象的address、addresses属性值为undefined,默认值为true。 如果解析地址信息失败则返回的Position对象的address、addresses属性值为null。
GeolocationError
JSON对象,定位错误信息
说明:
这里根据W3C规范定义了定位标准错误码,在此基础上5+ 扩展了错误码,参考 5+ API错误代码中的“Geolocation模块错误”
常量:
属性:
- code: (Number 类型 )错误代码
可取值:
- PERMISSION_DENIED - 用户拒绝授权
- POSITION_UNAVAILABLE - 位置服务不可用,如系统定位服务关闭
- TIMEOUT - 定位超时,定位时超过PositionOptions.timeout设置的时间触发,此时通常可以重试
- 其它错误 - 5+ 扩展错误码,参考 5+ API错误代码中的“Geolocation模块错误”
- message: (String 类型 )错误描述信息
详细错误描述信息。
GeolocationSuccessCallback
获取设备位置信息成功的回调函数
参数:
- position: ( Position ) 必选 设备的地理位置信息,参考Position
返回值:
void : 无
示例:
uni-app使用plus注意事项
GeolocationErrorCallback
获取设备位置信息失败的回调函数
参数:
返回值:
void : 无
示例: