From db1f8f7529b9c7ebebfe13ac0ed275dd2e5a4771 Mon Sep 17 00:00:00 2001 From: VK <370725567@qq.com> Date: Wed, 28 Jun 2023 20:54:57 +0800 Subject: [PATCH] Update uni-map-service.md --- docs/uniCloud/uni-map-service.md | 55 ++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/docs/uniCloud/uni-map-service.md b/docs/uniCloud/uni-map-service.md index 5fbc73c3f..0fb7678fc 100644 --- a/docs/uniCloud/uni-map-service.md +++ b/docs/uniCloud/uni-map-service.md @@ -422,6 +422,61 @@ console.log("result", result); |   |-- city |String |市 |腾讯地图 | |   |-- district |String |区/县 |腾讯地图 | +### 行政区域查询@districtSearch + +**功能介绍** + +用于获取全部省市区三级行政区划列表。 + +**示例** + +```js +// 引入uni-map-service公共模块 +const UniMapService = require('uni-map-service'); +// 初始化实例 +let uniMapService = new UniMapService({ + provider: "qqmap", // 指定使用哪家地图供应商 + key: "xxxxxx" +}); +// 调用API +let result = await uniMapService.districtSearch({ + adcode: "110101" +}); +console.log("result", result); +``` + +**请求参数** + +|参数 |类型 |必填 |说明 |兼容性 | +|:-- |:-: |:-: |:-- |:-: | +|adcode |String |否 | 父级行政区划adcode |all | +|get\_polygon |Number |否 | 返回行政区划轮廓点串(经纬度点串),取值:
0 默认,不返回轮廓
1 包含海域,3公里抽稀粒度
2 纯陆地行政区划,可通过max_offset设置返回轮廓的抽稀级别
注:乡镇/街道(四级)不支持返回轮廓|腾讯地图:0、1、2 高德地图:0、2 | +|max\_offset |Number |否 | 轮廓点串的抽稀精度(仅对get_polygon=2时支持),
单位米,可选值:
100 :100米(当缺省id返回省级区划时,将按500米返回,其它级别正常生效)
500 :500米
1000:1000米
3000:3000米 |腾讯地图 | +|page\_index |Number |否 | 页码,从1开始,最大页码需通过count进行计算,必须与page_size同时使用 |高德地图 | +|page\_size |Number |否 | 每页条数,取值范围1-20,必须与page_index 同时使用 |高德地图 | +|filter |String |否 |按照指定行政区划进行过滤,填入后则只返回该省/直辖市信息
需填入adcode,为了保证数据的正确,强烈建议填入此参数 |高德地图 | +|subdistrict |Number |否 |可选值:
1:返回下一级行政区;
2:返回下两级行政区;
3:返回下三级行政区; |高德地图 | + + +**返回参数** + +仅列出result内的参数,其他参数见 [公共返回参数](#publicresult) + +|参数 |类型 |说明 |兼容性 | +|:-- |:-: |:-- |:-: | +|data |Array | 结果数组 |all | +|  |-- adcode |String | 行政区划唯一标识 |all | +|  |-- name |String |简称,如“内蒙古” 注意:高德地图name = fullname |all | +|  |-- fullname |String |全称,如“内蒙古自治区” |all | +|  |-- location |String |经纬度 |all | +|   |-- lat|Number |纬度 |all | +|   |-- lng|Number |经度 |all | +|  |-- pinyin |Array |行政区划拼音,每一下标为一个字的全拼,如:[“nei”,“meng”,“gu”] |腾讯地图 | +|  |-- cidx |Array |子级行政区划在下级数组中的下标位置 |腾讯地图 | +|  |-- polygon |Array |该行政区划的轮廓经纬度点串(当使用get_polygon=1或2时返回),数组每一项为一个多边形,一个行政区划可以由多块多边形组成
注意:部分城市存在飞地,当两个polygon重叠时,重叠区域隶属其他城市,不重叠时代表此城市的飞地 |腾讯地图 | +|  |-- level |Array |行政区划级别 |高德地图 | +|  |-- children |Array |下级行政区列表,需传subdistrict参数才会有此值 |高德地图 | + ### 路线规划(导航)@route #### 驾车(driving)@drivingroute -- GitLab