---
name: "getLocation"
mode: "kit"
versionRequirements:
  - { name: "MapKit", version: "1.0.6" }
  - { name: "@ray-js/ray", version: "1.2.10" }
platform:
  - "iOS"
  - "Android"
async: true
title: "map.getLocation - 获取当前的地理位置、速度"
---

## getLocation

> [VERSION] MapKit >= 1.0.6 | @ray-js/ray >= 1.2.10

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

获取当前地理位置和速度

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `type` | `string` | 是 | - | `1.0.6` | wgs84返回GPS坐标，gcj02返回可用于openLocation的坐标 |
| `altitude` | `boolean` | 是 | - | `1.0.6` | 传入true会返回高度信息。由于获取高度需要较高精度，会减慢接口响应速度。 |
| `isHighAccuracy` | `boolean` | 是 | - | `1.0.6` | 开启高精度定位 |
| `highAccuracyExpireTime` | `number` | 是 | - | `1.0.6` | 高精度定位超时时间(ms)。指定时间内返回最高精度，该值3000ms以上高精度定位才有效果。 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `latitude` | `number` | `3.0.5` | 纬度，范围 -90~90，负数表示南纬 |
| `longitude` | `number` | `3.0.5` | 经度，范围 -180~180，负数表示西经 |
| `speed` | `number` | `3.0.5` | 速度，单位 m/s |
| `accuracy` | `number` | `3.0.5` | 定位精度 |
| `altitude` | `number` | `3.0.5` | 海拔，单位 m |
| `verticalAccuracy` | `number` | `3.0.5` | 垂直精度，单位 m（Android无法获取，返回0） |
| `horizontalAccuracy` | `number` | `3.0.5` | 水平精度，单位 m |
| `cityName` | `string` | `3.0.5` | 城市名称 |
| `streetName` | `string` | `3.0.5` | 街道名称 |
| `address` | `string` | `3.0.5` | 位置名称，历史上iOS返回Array类型，建议使用formatAddress字段 |
| `formatAddress` | `string` | `3.6.0` | 格式化地址 |
| `countryCode` | `string` | `3.1.0` | 国家代码 |
| `postalCode` | `string` | `3.1.0` | 邮政编码 |
| `countryName` | `string` | `3.1.1` | 国家名称 |
| `province` | `string` | `3.1.1` | 省份名称 |
| `district` | `string` | `3.1.1` | 区县名称，二级区域名称 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 示例代码

#### 基础调用

```tsx
import { map } from '@ray-js/ray'

const { getLocation } = map;

getLocation({
  type: 'gcj02',
  altitude: false,
  isHighAccuracy: false,
  highAccuracyExpireTime: 3000,
  success: (result) => {
    console.log('getLocation success', result);
  },
  fail: (error) => {
    console.log('getLocation fail', error.errorMsg);
  },
});
```