title: Location

使用 Location 实例进行读写地理位置数据和查询。

方法

customPosition

定义

customPosition(locationArray, PositionOptions)

说明

初始化一个用户自定义的 Position 对象，可以自由设置 Position 中的属性。

参数
参数名 说明
locationArray Array 类型。
一个包含经纬度的数组，数组的第一个数据为 float 型的纬度，第二个数据为 float 型的经度。
PositionOptions PositionOptions 类型，设置将要创建的本地媒体流属性。
返回值

初始化成功的 Position 实例。


setPosition

定义

setPosition(keyOrPositions[, position])

说明

手动将位置数据写入到对应节点。

参数
参数名 说明
keyOrPositions String 或 Object 类型，如果类型为 String ，只有一个位置信息会保存，保存到这个 key 节点下。也可以是个包含 key 值和 Position 对象的 Map ，一次写入多个位置。
position Position 类型，当 keyOrPositions 为 String 时需要传这个 Position 参数。
返回值

Promise


onPosition

定义

onPosition(key, callback)

说明

监听 key 对应的地理位置变化

参数
参数名 说明
key String 类型，对应一个记录地理位置单位的唯一标识。
callback Function 类型，监听到 key 对应单位的地理位置发生变化时触发的回调。
返回值

CallbackRegistration


offPosition

定义

offPosition([key])

说明

取消所有监听 key 的位置信息，如果 key 为 null 则取消所有对 Position 的监听。

参数
参数名 说明
key String 类型，对应一个记录地理位置单位的唯一标识。


getPosition

定义

getPosition(key)

说明

获取 key 当前的地理位置信息。

参数
参数名 说明
key String 类型，对应一个记录地理位置单位的唯一标识。
返回值

Promise<Position>


removePosition

定义

removePosition(key)

说明

删除 key 当前的地理位置信息。

参数
参数名 说明
key String 类型，对应一个记录地理位置单位的唯一标识。
返回值

Promise


removePath

定义

removePath(key)

说明

删除 key 对应的轨迹信息。

参数
参数名 说明
key String 类型，对应一条轨迹的唯一标识。
返回值

Promise


circleQuery

定义

circleQuery(circleQueryCriteria)

说明

用于查询某个范围内的点的类。

参数
参数名 说明
CircleQueryCriteria CircleQueryCriteria 类型，范围查询的条件 Map。
返回值

CircleQuery


pathQuery

定义

pathQuery(key, PathQueryOptions)

说明

用于查询某个范围内的点的类。

参数
参数名 说明
key String 类型。
一个轨迹的唯一标识符。
PathQueryOptions PathQueryOptions 类型，范围查询的条件 Map。
返回值

PathQuery


AMapLocationProvider

定义

AMapLocationProvider(type, number)

说明

初始化一个根据时间间隔更新地理位置的 AMapLocationProvider 。

参数
参数名 说明
type String 类型，采集地理位置的间隔类型，包括”timeInterval”和”distanceInterval”。
number Int 类型，时间间隔（ms）或 距离间隔（m）。
返回值

AMapLocationProvider


startTracingPosition

定义

startTracingPosition(key[, AMapLocationProvider])

说明

开启位置持续更新，用户可以传入 AMapLocationProvider 对象。如果没有提供 AMapLocationProvider ，默认以时间间隔为5秒的 AMapLocationProvider 进行更新。

参数
参数名 说明
key String 类型，对应一个记录地理位置单位的唯一标识。
AMapLocationProvider AMapLocationProvider 类型，提供地理位置。


stopTracingPosition

定义

stopTracingPosition(key)

说明

终止 key 的地理位置更新。

参数
参数名 说明
key String 类型，对应一个记录地理位置单位的唯一标识。


startRecordingPath

定义

startRecordingPath(key[, AMapLocationProvider])

说明

开启轨迹持续更新，用户可以传入 AMapLocationProvider 对象。如果没有提供 AMapLocationProvider ，默认以时间间隔为5秒的 AMapLocationProvider 进行更新。

参数
参数名 说明
key String 类型，对应一个记录地理位置单位的唯一标识。
AMapLocationProvider AMapLocationProvider 类型，提供地理位置。


stopRecordingPath

定义

stopRecordingPath(key)

说明

终止 key 的轨迹更新。

参数
参数名 说明
key String 类型，对应一个轨迹的唯一标识。


wilddog.Location.distance

定义

wilddog.Location.distance(position1, position2)

说明

计算两个点之间的距离, 单位 m。

参数
参数名 说明
Position Position 类型，一个地理位置对象。
返回值

Number


常量

PositionOptions

类型

  1. Object
说明

设置将要创建的自定义位置对象的属性。

参数
参数名 说明
timestamp Int 类型。
时间戳。
customAttributes String 类型。
用户自定义属性，如果是 Object 类型需转换成 String 后进行保存。

CircleQueryCriteria

类型

  1. Object
说明

设置范围查询的条件。

参数
参数名 说明
center Position 类型。
一个 Position 对象，将作为范围查询的中心。
radius Int 类型。
范围查询的半径，单位是 m 。

PathQueryOptions

类型

  1. Object
说明

设置轨迹查询的条件。

参数
参数名 说明
startTime Int 类型。
查询轨迹的开始时间，一个时间戳。
endTime Int 类型。
查询轨迹的结束时间，一个时间戳。