<commit_before>[TOC]
# 1、简介[![](http://appcan-download.oss-cn-beijing.aliyuncs.com/%E5%85%AC%E6%B5%8B%2Fgf.png)]()
定位插件
## 1.1、说明
定位功能。同时使用GPS,GPRS,WIFI三种方式联合定位,取最先返回值。
## 1.2、UI展示
![](http://newdocx.appcan.cn/docximg/160943n2015l6y16l.jpg)
## 1.3、开源源码
插件测试用例与源码下载:[点击](http://plugin.appcan.cn/details.html?id=177_index) 插件中心至插件详情页 (插件测试用例与插件源码已经提供)

## 1.4、平台版本支持
本插件的所有API默认支持**Android4.0+**和**iOS7.0+**操作系统。
有特殊版本要求的API会在文档中额外说明。

## 1.5、接口有效性
本插件所有API默认在插件版本**4.0.0+**可用。
在后续版本中新添加的接口会在文档中额外说明。

# 2、API概览

## 2.1、方法
> ### openLocation 打开定位功能,监听并返回设备所在地经纬度信息

`uexLocation.openLocation(callBackFunction)`

**说明:**

位置信息将通过手机GPS、WIFI或移动网络信号获取。成功打开定位功能时会执行回调方法,成功获取到位置信息时通过[onChange](#onChange 设备位置变化的监听方法 "onChange")回调方法返回。

**参数:**

 无

**示例:**

```
uexLocation.openLocation(function(data) {
    alert(data); //data值为  0: 成功  1: 失败
});
```



> ### closeLocation 关闭定位功能

`uexLocation.closeLocation()`

**说明:**

关闭定位功能,不再监听位置信息。

**参数:**

 无

**示例:**

```
    uexLocation.closeLocation();
```

> ### getAddress 获取经纬度对应的具体地址信息

`uexLocation.getAddress(inLatitude,inLongitude,flag, callbackFunction)`

**说明:**
根据经纬度获取对应的地址信息，执行完成后会回调传入的函数`callbackFunction`

**参数:**


|  参数名称 | 参数类型  | 是否必选  |  说明 |
| ----- | ----- | ----- | ----- |
| inLatitude | Number | 是 | 纬度 |
| inLongitude | Number | 是 | 经度 |
| flag | Number | 是 | 返回地址类型,默认是地址名称。值为1时返回地址详情(JSON格式)|
|callbackFunction|Function|是| 获取地址成功后的回调函数|

回调函数中返回的数据是JSON对象(如果出错会返回ErrorCode)，格式如下:

```
{
    "formatted_address": "北京市海淀区海淀中街15号",
    "location": {
        "lat": 39.983197,
        "lng": 116.317383
    },
    "addressComponent": {
        "province": "北京市",
        "street_number": "15号",<commit_msg>更新uexLocation文档<commit_after>[TOC]
# 1、简介[![](http://appcan-download.oss-cn-beijing.aliyuncs.com/%E5%85%AC%E6%B5%8B%2Fgf.png)]()
定位插件
## 1.1、说明
定位功能。同时使用GPS,GPRS,WIFI三种方式联合定位,取最先返回值。
## 1.2、UI展示
![](http://newdocx.appcan.cn/docximg/160943n2015l6y16l.jpg)
## 1.3、开源源码
插件测试用例与源码下载:[点击](http://plugin.appcan.cn/details.html?id=177_index) 插件中心至插件详情页 (插件测试用例与插件源码已经提供)

## 1.4、平台版本支持
本插件的所有API默认支持**Android4.0+**和**iOS7.0+**操作系统。
有特殊版本要求的API会在文档中额外说明。

## 1.5、接口有效性
本插件所有API默认在插件版本**4.0.0+**可用。
在后续版本中新添加的接口会在文档中额外说明。

# 2、API概览

## 2.1、方法
> ### openLocation 打开定位功能,监听并返回设备所在地经纬度信息

`uexLocation.openLocation(callBackFunction)`

**说明:**

位置信息将通过手机GPS、WIFI或移动网络信号获取。成功打开定位功能时会执行回调方法,成功获取到位置信息时通过[onChange](#onChange 设备位置变化的监听方法 "onChange")回调方法返回。

**参数:**

 无

**示例:**

```
uexLocation.openLocation(function(data) {
    alert(data); //data值为  0: 成功  1: 失败
});
```



> ### closeLocation 关闭定位功能

`uexLocation.closeLocation()`

**说明:**

关闭定位功能,不再监听位置信息。

**参数:**

 无

**示例:**

```
    uexLocation.closeLocation();
```

> ### getAddress 获取经纬度对应的具体地址信息

`uexLocation.getAddress(inLatitude,inLongitude,flag, callbackFunction)`

**说明:**
根据经纬度获取对应的地址信息，执行完成后会回调传入的函数`callbackFunction`

**参数:**


|  参数名称 | 参数类型  | 是否必选  |  说明 |
| ----- | ----- | ----- | ----- |
| inLatitude | Number | 是 | 纬度 |
| inLongitude | Number | 是 | 经度 |
| flag | Number | 是 | 值为1时返回地址详情(JSON格式), 非 1 时返回地址名称|
|callbackFunction|Function|是| 获取地址成功后的回调函数|

回调函数中返回的数据是JSON对象(如果出错会返回ErrorCode)，格式如下:

```
{
    "formatted_address": "北京市海淀区海淀中街15号",
    "location": {
        "lat": 39.983197,
        "lng": 116.317383
    },
    "addressComponent": {
        "province": "北京市",
        "street_number": "15号",
{'fraction_non_alphanumeric': 0.1999400479616307, 'fraction_numerical': 0.04106714628297362, 'mean_word_length': 4.714041095890411, 'pattern_counts': {'":': 14, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3085581', 'n_tokens_mistral': 2061, 'n_tokens_neox': 2177, 'n_words': 168}