@agreejs/agree

declare namespace Agree { namespace openLocation { interface Option { /** 纬度，范围为-90~90，负数表示南纬。使用 gcj02 国测局坐标系 */ latitude: number /** 经度，范围为-180~180，负数表示西经。使用 gcj02 国测局坐标系 */ longitude: number /** 地址的详细说明 */ address?: string /** 接口调用结束的回调函数（调用成功、失败都会执行） */ complete?: (res: General.CallbackResult) => void /** 接口调用失败的回调函数 */ fail?: (res: General.CallbackResult) => void /** 位置名 */ name?: string /** 缩放比例，范围5~18 */ scale?: number /** 接口调用成功的回调函数 */ success?: (res: General.CallbackResult) => void } } /** 使用微信内置地图查看位置 * @supported weapp, h5 * @example * ```tsx * Agree.getLocation({ * type: 'gcj02', //返回可以用于 Agree.openLocation的经纬度 * success: function (res) { * const latitude = res.latitude * const longitude = res.longitude * Agree.openLocation({ * latitude, * longitude, * scale: 18 * }) * } * }) * ``` * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.openLocation.html */ function openLocation(option: openLocation.Option): Promise<General.CallbackResult> namespace getLocation { interface Option { /** 传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度 */ altitude?: string /** 接口调用结束的回调函数（调用成功、失败都会执行） */ complete?: (res: General.CallbackResult) => void /** 接口调用失败的回调函数 */ fail?: (res: General.CallbackResult) => void /** 高精度定位超时时间(ms)，指定时间内返回最高精度，该值3000ms以上高精度定位才有效果 */ highAccuracyExpireTime?: number /** 开启高精度定位 */ isHighAccuracy?: boolean /** 接口调用成功的回调函数 */ success?: (result: SuccessCallbackResult) => void /** wgs84 返回 gps 坐标，gcj02 返回可用于 Agree.openLocation 的坐标 */ type?: string } interface SuccessCallbackResult extends General.CallbackResult { /** 位置的精确度 */ accuracy: number /** 高度，单位 m */ altitude: number /** 水平精度，单位 m */ horizontalAccuracy: number /** 纬度，范围为 -90~90，负数表示南纬 */ latitude: number /** 经度，范围为 -180~180，负数表示西经 */ longitude: number /** 速度，单位 m/s */ speed: number /** 垂直精度，单位 m（Android 无法获取，返回 0） */ verticalAccuracy: number /** 调用结果 */ errMsg: string } } /** 获取当前的地理位置、速度。当用户离开小程序后，此接口无法调用。开启高精度定位，接口耗时会增加，可指定 highAccuracyExpireTime 作为超时时间。 * * **注意** * - 工具中定位模拟使用IP定位，可能会有一定误差。且工具目前仅支持 gcj02 坐标。 * - 使用第三方服务进行逆地址解析时，请确认第三方服务默认的坐标系，正确进行坐标转换。 * @supported weapp * @example * ```tsx * Agree.getLocation({ * type: 'wgs84', * success: function (res) { * const latitude = res.latitude * const longitude = res.longitude * const speed = res.speed * const accuracy = res.accuracy * } * }) * ``` * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.getLocation.html */ function getLocation(option: getLocation.Option): Promise<getLocation.SuccessCallbackResult> namespace chooseLocation { interface Option { /** 接口调用结束的回调函数（调用成功、失败都会执行） */ complete?: (res: General.CallbackResult) => void /** 接口调用失败的回调函数 */ fail?: (res: General.CallbackResult) => void /** 目标地纬度 */ latitude?: number /** 目标地经度 */ longitude?: number /** 接口调用成功的回调函数 */ success?: (result: SuccessCallbackResult) => void } interface SuccessCallbackResult extends General.CallbackResult { /** 详细地址 */ address: string /** 纬度，浮点数，范围为-90~90，负数表示南纬。使用 gcj02 国测局坐标系 */ latitude: string /** 经度，浮点数，范围为-180~180，负数表示西经。使用 gcj02 国测局坐标系 */ longitude: string /** 位置名称 */ name: string /** 调用结果 */ errMsg: string } } /** 打开地图选择位置。 * * `chooseLocation` api功能是依赖于腾讯位置服务，所以需要使用 api 密钥。如果您没有，可以前往腾讯位置服务[开发者控制台](https://lbs.qq.com/console/mykey.html?console=mykey)进行申请。 * @supported weapp, h5 * @example * * ```tsx * // config/index.js * * // 获得 api 密钥后，您需要将它填入项目的常量配置`defineConstants.LOCATION_APIKEY`中： * const config = { * defineConstants: { * LOCATION_APIKEY: JSON.stringify('XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX') * }, * // ... * } * ``` * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.chooseLocation.html */ function chooseLocation(option: chooseLocation.Option): Promise<chooseLocation.SuccessCallbackResult> namespace stopLocationUpdate { interface Option { /** 接口调用结束的回调函数（调用成功、失败都会执行） */ complete?: (res: General.CallbackResult) => void /** 接口调用失败的回调函数 */ fail?: (res: General.CallbackResult) => void /** 接口调用成功的回调函数 */ success?: (res: General.CallbackResult) => void } } /** 关闭监听实时位置变化，前后台都停止消息接收 * @supported weapp * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.stopLocationUpdate.html */ function stopLocationUpdate(option?: stopLocationUpdate.Option): void namespace startLocationUpdateBackground { interface Option { /** 接口调用结束的回调函数（调用成功、失败都会执行） */ complete?: (res: General.CallbackResult) => void /** 接口调用失败的回调函数 */ fail?: (res: General.CallbackResult) => void /** 接口调用成功的回调函数 */ success?: (res: General.CallbackResult) => void } } /** 开启小程序进入前后台时均接收位置消息，需引导用户开启[授权]((open-ability/authorize#后台定位))。授权以后，小程序在运行中或进入后台均可接受位置消息变化。 * * **注意** * - 安卓微信7.0.6版本，iOS 7.0.5版本起支持该接口 * - 需在app.json中配置requiredBackgroundModes: ['location']后使用 * - 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。 * @supported weapp * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdateBackground.html */ function startLocationUpdateBackground( option?: startLocationUpdateBackground.Option, ): void namespace startLocationUpdate { interface Option { /** 接口调用结束的回调函数（调用成功、失败都会执行） */ complete?: (res: General.CallbackResult) => void /** 接口调用失败的回调函数 */ fail?: (res: General.CallbackResult) => void /** 接口调用成功的回调函数 */ success?: (res: General.CallbackResult) => void } } /** 开启小程序进入前台时接收位置消息 * * **注意** * - 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。 * @supported weapp * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdate.html */ function startLocationUpdate(option?: startLocationUpdate.Option): void namespace onLocationChange { /** 实时地理位置变化事件的回调函数 */ type Callback = ( result: CallbackResult, ) => void interface CallbackResult { /** 位置的精确度 */ accuracy: number /** 高度，单位 m */ altitude: number /** 水平精度，单位 m */ horizontalAccuracy: number /** 纬度，范围为 -90~90，负数表示南纬 */ latitude: number /** 经度，范围为 -180~180，负数表示西经 */ longitude: number /** 速度，单位 m/s */ speed: number /** 垂直精度，单位 m（Android 无法获取，返回 0） */ verticalAccuracy: number } } /** 监听实时地理位置变化事件，需结合 Agree.startLocationUpdateBackground、Agree.startLocationUpdate 使用。 * @supported weapp * @example * ```tsx * const _locationChangeFn = function (res) { * console.log('location change', res) * } * Agree.onLocationChange(_locationChangeFn) * Agree.offLocationChange(_locationChangeFn) * ``` * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.onLocationChange.html */ function onLocationChange( /** 实时地理位置变化事件的回调函数 */ callback: onLocationChange.Callback, ): void /** 取消监听实时地理位置变化事件 * @supported weapp * @see https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChange.html */ function offLocationChange( /** 实时地理位置变化事件的回调函数 */ callback: (res: General.CallbackResult) => void, ): void }