智能小程序 Ray 开发——位置 API 接口汇总（一）

map.getLocation

获取当前的地理位置、速度

需引入MapKit，且在>=1.0.6版本才可使用

Use in Ray

// @ray-js/ray >=1.1.0
import { map } from '@ray-js/ray';
const { getLocation } = map;

参数

Object object

属性	类型	默认值	必填	说明
type	string		是	wgs84 返回 gps 坐标，gcj02 返回可用于 openLocation 的坐标
altitude	boolean		是	传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度
isHighAccuracy	boolean		是	开启高精度定位
highAccuracy ExpireTime	number		是	高精度定位超时时间(ms)，指定时间内返回最高精度，该值 3000ms 以上高精度定位才有效果
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
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
cityName	string	城市名称street
streetName	string	街道名称
address	string	位置名称
countryCode	string	国家码
postalCode	string	邮编
countryName	string	国家名
province	string	省名
district	string	区名, 次级区域名

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 获取当前的地理位置、速度
 */
export function getLocation(params: {
  /** wgs84 返回 gps 坐标，gcj02 返回可用于 openLocation 的坐标 */
  type: string;
  /** 传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度 */
  altitude: boolean;
  /** 开启高精度定位 */
  isHighAccuracy: boolean;
  /** 高精度定位超时时间(ms)，指定时间内返回最高精度，该值3000ms以上高精度定位才有效果 */
  highAccuracyExpireTime: number;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 纬度，范围为 -90~90，负数表示南纬 */
    latitude: number;
    /** 经度，范围为 -180~180，负数表示西经 */
    longitude: number;
    /** 速度，单位 m/s */
    speed: number;
    /** 位置的精确度 */
    accuracy: number;
    /** 高度，单位 m */
    altitude: number;
    /** 垂直精度，单位 m（Android 无法获取，返回 0） */
    verticalAccuracy: number;
    /** 水平精度，单位 m */
    horizontalAccuracy: number;
    /** 城市名称street */
    cityName: string;
    /** 街道名称 */
    streetName: string;
    /** 位置名称 */
    address: string;
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。 

map.getMapList

获取可跳转第三方地图的地图类型

需引入MapKit，且在>=2.1.1版本才可使用

Use in Ray

// @ray-js/ray >=1.1.0
import { map } from '@ray-js/ray';
const { getMapList } = map;

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
maps	array	可跳转的地图厂商，目前支持：BMK：百度地图 MA：高德地图 TENCENT：腾讯地图 Google：Google 地图

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 获取可跳转第三方地图的地图类型
 */
export function getMapList(params?: {
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: {
    /** 可跳转的地图厂商，目前支持：BMK：百度地图 MA：高德地图 TENCENT：腾讯地图 Google：Google地图 */
    maps: string[];
  }) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即免费领取开发资源，体验涂鸦 MiniApp 小程序开发。