提交 5bf08a52 编写于 作者: d-u-a's avatar d-u-a

docs: update map组件和API

上级 29e618b9
......@@ -26,6 +26,20 @@ mapContext
|includePoints|OBJECT|缩放视野展示所有经纬度|app-nvue 2.1.5+||
|getRegion|OBJECT|获取当前地图的视野范围|||
|getScale|OBJECT|获取当前地图的缩放级别|||
|addCustomLayer|OBJECT|添加个性化图层||App暂不支持 (**SDK不支持**),微信小程序|
|addGroundOverlay|OBJECT|创建自定义图片图层,图片会随着地图缩放而缩放||App-nvue 3.1.0+,微信小程序|
|addMarkers |OBJECT|添加 marker||App-nvue 3.1.0+,微信小程序|
|fromScreenLocation|OBJECT|获取屏幕上的点对应的经纬度,坐标原点为地图左上角||App暂不支持,微信小程序|
|initMarkerCluster|OBJECT|初始化点聚合的配置,未调用时采用默认配置||App-nvue 3.1.0+,微信小程序|
|moveAlong|OBJECT|沿指定路径移动 marker,用于轨迹回放等场景。动画完成时触发回调事件,若动画进行中,对同一 marker 再次调用 moveAlong 方法,前一次的动画将被打断。|支持 android 不支持autoRotate属性设置 默认ture|App-nvue 3.1.0+,微信小程序|
|openMapApp|OBJECT|拉起地图APP选择导航。||App-nvue 3.1.0+,微信小程序|
|removeCustomLayer|OBJECT|移除个性化图层 ||App暂时不支持 (**SDK不支持**),微信小程序|
|removeGroundOverlay|OBJECT|移除自定义图片图层||App-nvue 3.1.0+,微信小程序|
|removeMarkers|OBJECT|移除 marker。||App-nvue 3.1.0+,微信小程序|
|setCenterOffset|OBJECT|设置地图中心点偏移,向后向下为增长,屏幕比例范围(0.25~0.75),默认偏移为[0.5, 0.5]||App暂时不支持,微信小程序|
|toScreenLocation|OBJECT|获取经纬度对应的屏幕坐标,坐标原点为地图左上角。||App暂时不支持,微信小程序|
|updateGroundOverlay|OBJECT|更新自定义图片图层。||App-nvue 3.1.0+,微信小程序|
|on|EventHandle|监听地图事件。||App-nvue 3.1.0+,微信小程序|
|$getAppMap||获取原生地图对象 [plus.maps.Map](https://www.html5plus.org/doc/zh_cn/maps.html#plus.maps.Map)|app-vue自定义组件模式|1.9.3|
`$getAppMap()` 注意事项:
......@@ -90,6 +104,102 @@ mapContext
|fail|Function|否|接口调用失败的回调函数|
|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)|
**addCustomLayer 的 OBJECT 参数列表**
|属性 |类型 |默认值 |必填 |说明 |
|:-|:-|:-|:-|:-|
|layerId |string | |是 |个性化图层id |
|success |function | |否 |接口调用成功的回调函数 |
|fail |function | |否 |接口调用失败的回调函数 |
|complete |function | |否 |接口调用结束的回调函数(调用成功、失败都会执行) |
**addGroundOverlay 的 OBJECT 参数列表**
|属性 |类型 |默认值 |必填 |说明 |
|:-|:-|:-|:-|:-|
|id |String | |是 |图片图层 id |
|src |String | |是 |图片路径,支持网络图片、临时路径、代码包路径 |
|bounds |Object | |是 |图片覆盖的经纬度范围 |
|visible |Boolean |true |否 |是否可见 |
|zIndex |Number |1 |否 |图层绘制顺序 |
|opacity |Number |1 |否 |图层透明度 |
|success |function | |否 |接口调用成功的回调函数 |
|fail |function | |否 |接口调用失败的回调函数 |
|complete |function | |否 |接口调用结束的回调函数(调用成功、失败都会执行) |
`object.bounds` 的结构
|属性 |类型 |默认值 |必填 |说明 |
|:-|:-|:-|:-|:-|
|southwest |Object | |是 |西南角经纬度 |
|northeast |Object | |是 |东北角经纬度 |
`southwest` 的结构
|属性 |类型 |默认值 |必填 |说明 |
|:-|:-|:-|:-|:-|
|longitude |number | |是 |经度 |
|latitude |number | |是 |纬度 |
`northeast` 的结构
|属性 |类型 |默认值 |必填 |说明 |
|:-|:-|:-|:-|:-|
|longitude |number | |是 |经度 |
|latitude |number | |是 |纬度 |
**addMarkers 的 OBJECT 参数列表**
|属性 |类型 |默认值 |必填 |说明 |
|:-|:-|:-|:-|:-|
|markers |Array | |是 |同传入 map 组件的 marker 属性 |
|clear |boolean |false |否 |是否先清空地图上所有 marker |
|success |function | |否 |接口调用成功的回调函数 |
|fail |function | |否 |接口调用失败的回调函数 |
|complete |function | |否 |接口调用结束的回调函数(调用成功、失败都会执行) |
**MapContext.on()**
`markerClusterCreate`
缩放或拖动导致新的聚合簇产生时触发,仅返回新创建的聚合簇信息。
返回参数
|参数 |类型 |说明 |
|:-|:-|:-|
|clusters |Array<ClusterInfo> |聚合簇数据 |
`markerClusterClick`
聚合簇的点击事件。
返回参数
|参数 |类型 |说明 |
|:-|:-|:-|
|cluster|ClusterInfo|聚合簇 |
`ClusterInfo` 结构
|参数 |类型 |说明 |
|:-|:-|:-|
|clusterId |Number |聚合簇的 id |
|center |LatLng |聚合簇的坐标 |
|markerIds |Array<Number>|该聚合簇内的点标记数据数组 |
示例代码
```
MapContext.on('markerClusterCreate', (res) => {})
MapContext.on('markerClusterClick', (res) => {})
```
## mapSearch 模块(module)
#### reverseGeocode(Object,callback)
......
......@@ -16,7 +16,10 @@
|:-|:-|:-|:-|:-|
|longitude|Number||中心经度||
|latitude|Number||中心纬度||
|scale|Number|16|缩放级别,取值范围为5-18||
|scale|Number|16|缩放级别,取值范围为3-20|高德地图缩放比例与微信小程序不同|
|min-scale|Number|3|最小缩放级别|App-nvue 3.1.0+、微信小程序2.13+|
|max-scale|Number|20|最大缩放级别|App-nvue 3.1.0+、微信小程序2.13+|
|layer-style|Number|1|个性化地图|App-nvue 3.1.0+、微信小程序2.13+|
|markers|Array||标记点||
|polyline|Array||路线||
|circles|Array||圆||
......@@ -30,8 +33,11 @@
|enable-overlooking|Boolean|false|是否开启俯视|App-nvue 2.1.5+、微信小程序2.3.0|
|enable-satellite|Boolean|false|是否开启卫星图|App-nvue 2.1.5+、微信小程序2.7.0|
|enable-traffic|Boolean|false|是否开启实时路况|App-nvue 2.1.5+、微信小程序2.7.0|
|enable-poi|Boolean|false|是否展示 POI 点|App-nvue 3.1.0+|
|enable-building|Boolean|false|是否展示建筑物|App-nvue 3.1.0+ 支持 (**废除原enable-3D属性 高德地图默认开启建筑物就是3D无法设置**)|
|show-location|Boolean||显示带有方向的当前定位点|微信小程序、H5、百度小程序、支付宝小程序|
|polygons|Array.`<polygon>`||多边形|App-nvue 2.1.5+、微信小程序、百度小程序、支付宝小程序|
|enable-indoorMap|Boolean|false|是否展示室内地图|App-nvue 3.1.0+|
|@markertap|EventHandle||点击标记点时触发,e.detail = {markerId}|App-nvue 2.3.3+, App平台需要指定 marker 对象属性 id|
|@labeltap|EventHandle||点击label时触发,e.detail = {markerId} |微信小程序2.9.0|
|@callouttap|EventHandle||点击标记点对应的气泡时触发,e.detail = {markerId}||
......@@ -39,6 +45,7 @@
|@regionchange|EventHandle||视野发生变化时触发|微信小程序、H5、百度小程序、支付宝小程序|
|@tap|EventHandle||点击地图时触发; App-nuve、微信小程序2.9支持返回经纬度||
|@updated|EventHandle||在地图渲染更新完成时触发|微信小程序、H5、百度小程序|
|@anchorpointtap|EventHandle||点击定位标时触发,e.detail = {longitude, latitude}|App-nvue 3.1.0+、微信小程序2.13+|
**注意**
......@@ -63,6 +70,10 @@
|callout|自定义标记点上方的气泡窗口|Object|否|支持的属性见下表,可识别换行符。|App-nvue 2.1.5+|
|label|为标记点旁边增加标签|Object|否|支持的属性见下表,可识别换行符。|App-nvue 2.1.5+、微信小程序、H5、App、百度小程序|
|anchor|经纬度在标注图标的锚点,默认底边中点|Object|否|{x, y},x表示横向(0-1),y表示竖向(0-1)。{x: .5, y: 1} 表示底边中点|App-nvue 2.1.5+、微信小程序、H5、百度小程序|
|joinCluster|是否参与点聚合|Boolean|否||App-nvue 3.1.0+、微信小程序|
|clusterId|自定义点聚合簇效果时使用|Number|否||App-nvue 3.1.0+、微信小程序|
|customCallout|自定义气泡窗口|Object|否||app暂时不支持、微信小程序|
|aria-label|无障碍访问,(属性)元素的额外描述|String|否||App-nvue 3.1.0+、微信小程序|
**marker 上的气泡 callout**
......@@ -92,6 +103,10 @@
|bgColor|背景色|String|App-nvue 2.1.5+、微信小程序、百度小程序|
|padding|文本边缘留白|Number|App-nvue 2.1.5+、微信小程序、百度小程序|
|textAlign|文本对齐方式。有效值: left, right, center|String|App-nvue 2.1.5+、微信小程序、百度小程序|
|joinCluster|是否参与点聚合|Boolean|App-nvue 3.1.0+、微信小程序|
|clusterId|自定义点聚合簇效果时使用|Number|App-nvue 3.1.0+、微信小程序|
|customCallout|自定义气泡窗口|Object|App暂时不支持、微信小程序|
|aria-label|无障碍访问,(属性)元素的额外描述|String|App-nvue 3.1.0+、微信小程序|
**polyline**
......@@ -107,6 +122,8 @@
|arrowIconPath|更换箭头图标|String|否|在arrowLine为true时生效|App-nvue 2.1.5+、微信小程序、百度小程序|
|borderColor|线的边框颜色|String|否||App-nvue 2.1.5+、微信小程序、H5、百度小程序|
|borderWidth|线的厚度|Number|否||App-nvue 2.1.5+、微信小程序、H5、百度小程序|
|colorList|彩虹线|Array|false|存在时忽略 color 值|App-nvue 3.1.0+、微信小程序|
|level|压盖关系,默认为 abovelabels|String|false||App不支持(**需SDK提供支持**)、微信小程序|
**polygon**<br>
指定一系列坐标点,根据 points 坐标数据生成闭合多边形
......@@ -118,6 +135,7 @@
|strokeColor|描边的颜色|String|否|十六进制|
|fillColor|填充颜色|String|否|十六进制|
|zIndex|设置多边形 Z 轴数值|Number|否||
|level|压盖关系,默认为 abovelabels|String|false|App不支持(**需SDK提供支持**)、微信小程序|
**circles**
......@@ -131,6 +149,7 @@
|fillColor|填充颜色|String|否|8位十六进制表示,后两位表示alpha值,如:#0000AA|
|radius|半径|Number|是||
|strokeWidth|描边的宽度|Number|否|&nbsp;|
|level|压盖关系,默认为 abovelabels|String|false|App不支持(**需SDK提供支持**)、微信小程序|
**controls**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册