覆盖物 最后更新时间: 2021年01月22日
覆盖物
覆盖物是指叠加在地图底图之上的一些常见要素,包括
类名 | 说明 | 是否插件 |
---|---|---|
AMap.Marker |
点标记 |
否 |
AMap.Icon |
图标类,用于作为Marker的icon属性 |
否 |
AMap.ElasticMarker |
灵活点标记,一种可以随着级别改变图标和大小的点标记 |
是 |
AMap.Text |
纯文本标记 |
否 |
AMap.Polyline |
覆盖物>折线 |
否 |
AMap.Polygon |
覆盖物>多边形 |
否 |
AMap.BezierCurve |
覆盖物>贝瑟尔曲线 |
否 |
AMap.Circle |
覆盖物>圆 |
否 |
AMap.CircleMarker |
覆盖物>圆点标记 |
否 |
AMap.Ellipse |
覆盖物>椭圆 |
否 |
AMap.Rectangle |
覆盖物>矩形 |
否 |
AMap.OverlayGroup |
覆盖物集合 |
否 |
AMap.GeoJSON |
GeoJSON用于实现GeoJSON和OverlayGroup的相互转化 |
否 |
AMap.GroundImage |
图片覆盖物 |
否 |
AMap.ContextMenu |
地图右键菜单 |
否 |
AMap.LabelMarker |
标注(自v1.4.14 新增) |
否 |
Marker类
点标记。
构造函数 | 说明 |
---|---|
AMap.Marker(opt:MarkerOptions) | 构造一个点标记对象,通过MarkerOptions设置点标记对象的属性 |
MarkerOptions | 类型 | 说明 |
---|---|---|
map |
Map | 要显示该marker的地图对象 |
position |
LngLat | 点标记在地图上显示的位置,默认为地图中心点 |
anchor |
String |
设置点标记锚点。
默认值:'top-left' 可选值:'top-left'|'top-center'|'top-right'|'middle-left'|'center'|'middle-right'|'bottom-left'|'bottom-center'|'bottom-right' (自v1.4.13 新增) |
offset |
Pixel | 点标记显示位置偏移量,默认值为Pixel(-10,-34)。Marker指定position后,默认以marker左上角位置为基准点(若设置了anchor,则以anchor设置位置为基准点),对准所给定的position位置,若需使marker指定位置对准在position处,需根据marker的尺寸设置一定的偏移量。 |
icon |
String/Icon | 需在点标记中显示的图标。可以是一个本地图标地址,或者Icon对象。有合法的content内容时,此属性无效 |
content |
String/Object | 点标记显示内容,可以是HTML要素字符串或者HTML DOM对象。content有效时,icon属性将被覆盖 |
topWhenClick |
Boolean | 鼠标点击时marker是否置顶,默认false ,不置顶
(自v1.3 新增) |
bubble |
Boolean | 是否将覆盖物的鼠标或touch等事件冒泡到地图上
(自v1.3 新增) 默认值:false |
draggable |
Boolean | 设置点标记是否可拖拽移动,默认为false |
raiseOnDrag |
Boolean | 设置拖拽点标记时是否开启点标记离开地图的效果 |
cursor |
String | 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor |
visible |
Boolean | 点标记是否可见,默认为true |
zIndex |
Number |
点标记的叠加顺序。地图上存在多个点标记叠加时,通过该属性使级别较高的点标记在上层显示 默认zIndex:100 |
angle |
Number |
点标记的旋转角度,广泛用于改变车辆行驶方向 注:angle属性是使用CSS3来实现的,支持IE9及以上版本 |
autoRotation |
Boolean |
是否自动旋转。点标记在使用moveAlong动画时,路径方向若有变化,点标记是否自动调整角度,默认为false。广泛用于自动调节车辆行驶方向。 IE8以下不支持旋转,autoRotation属性无效 |
animation |
String |
点标记的动画效果,默认值: “AMAP_ANIMATION_NONE” 可选值: “AMAP_ANIMATION_NONE”,无动画效果 “AMAP_ANIMATION_DROP”,点标掉落效果 “AMAP_ANIMATION_BOUNCE”,点标弹跳效果 |
shadow |
Icon | 点标记阴影,不设置该属性则点标记无阴影 |
title |
String | 鼠标滑过点标记时的文字提示,不设置则鼠标滑过点标无文字提示 |
clickable |
Boolean | 点标记是否可点击 |
shape |
MarkerShape | 设置Marker的可点击区域,在定义的区域内可触发Marker的鼠标点击事件 |
extData |
Any | 用户自定义属性,支持JavaScript API任意数据类型,如Marker的id等 |
label |
{content,offset,direction} | 添加文本标注。content 为文本标注的内容。direction 为文本标注方位(自 v1.4.14 新增属性),可选值:'top'|'right'|'bottom'|'left'|'center',默认值:'top' 。offset 为偏移量(默认基准点为图标左上角),如设置了 direction,以 direction 方位为基准点进行偏移。相关示例 |
方法 | 返回值 | 说明 |
---|---|---|
markOnAMAP(obj:Object) | 唤起高德地图客户端标注页 其中Object里面包含有{ name:String,name属性 必要参数 position: LngLat 坐标点 } | |
getAnchor( ) |
String | 获取Marker锚点
(自v1.4.13 新增) |
setAnchor(anchor:String) |
| 设置Marker锚点
可选值:'top-left'|'top-center'|'top-right'|'middle-left'|'center'|'middle-right'|'bottom-left'|'bottom-center'|'bottom-right' (自v1.4.13 新增)
|
getOffset( ) |
Pixel | 获取Marker偏移量
(自v1.3 新增) |
setOffset(offset:Pixel) |
| 设置Marker偏移量
(自v1.3 新增) |
setAnimation(animate:String
) |
|
设置点标记的动画效果,默认值: “AMAP_ANIMATION_NONE” 可选值: “AMAP_ANIMATION_NONE”,无动画效果 “AMAP_ANIMATION_DROP”,点标掉落效果 “AMAP_ANIMATION_BOUNCE”,点标弹跳效果 |
getAnimation( ) |
String
| 获取点标记的动画效果类型 |
setClickable(clickable:Boolean
) |
| 设置点标记是支持鼠标单击事件 |
getClickable( ) |
Boolean | 获取点标记是否支持鼠标单击事件 |
getPosition( ) |
LngLat | 获取点标记的位置 |
setPosition(lnglat:LngLat) |
| 设置点标记位置 |
setAngle(angle:Number) |
| 设置点标记的旋转角度 |
setLabel(label:Object) |
| 设置点标记文本标签内容相关示例 |
getLabel() |
Object | 获取点标记文本标签内容 |
getAngle() |
Number | 获取点标记的旋转角度 |
setzIndex(index:Number) |
| 设置点标记的叠加顺序,默认最先添加的点标记在最底层 |
getzIndex() |
Number | 获取点标记的叠加顺序 |
setIcon(content:String/Icon) |
|
设置点标记的显示图标。 参数image可传入String、Icon两种类型的值。 若为String(图片url),表示点标记以指定图片形式显示;若为Icon,表示点标记以Icon对象形式显示 |
getIcon( ) |
String
/Icon | 当点标记未自定义图标时,获取Icon内容 |
setDraggable(draggable:Boolean) |
| 设置点标记对象是否可拖拽移动 |
getDraggable( ) |
Boolean | 获取点标记对象是否可拖拽移动 |
hide( ) |
| 点标记隐藏 |
show( ) |
| 点标记显示 |
setCursor(Cursor) |
String |
设置鼠标悬停时的光标。 参数cur可为CSS标注中的光标样式,如:
setCursor(“pointer”)等;或者自定义的光标样式,如: setCursor("url('https://webapi.amap.com/images/0.png') ,pointer") 注:当浏览器不支持css2,url值不起作用,鼠标样式就按pointer来设置 |
setContent(html:String|htmlDOM) |
| 设置点标记显示内容,可以是HTML要素字符串或者HTML DOM对象 |
getContent( ) |
String | 获取点标记内容 |
moveAlong(path:Array, |
|
以指定的速度,点标记沿指定的路径移动。参数path为轨迹路径的经纬度对象的数组;speed为指定速度,单位:千米/小时,不可为0; 回调函数f为变化曲线函数,缺省为function(k){return k};参数circlable表明是否循环执行动画,默认为false |
moveTo(lnglat:LngLat,speed:Number, |
| 以给定速度移动点标记到指定位置。参数lnglat为指定位置,必设;speed为指定速度,单位:千米/小时,不可为0;回调函数f为变化曲线函数,缺省为function(k){return k}。 |
stopMove( ) |
| 点标记停止动画 |
pauseMove() |
| 暂定点标记的动画效果 |
resumeMove() |
| 重新开始点标记的动画效果 |
setMap(map:Map) |
| 为Marker指定目标显示地图。当参数值取null时,地图上移除当前Marker:setMap(null) |
getMap() |
Map | 获取Marker所在地图对象 |
setTitle(title:String) |
| 鼠标滑过点标时的文字提示 |
getTitle( ) |
String | 获取点标记的文字提示 |
setTop(isTop:Boolean) |
| 地图上有多个marker时,当isTop为true时,marker将显示在最前面;当为false时,marker取消置顶 |
getTop( ) |
Boolean | |
setShadow(icon:Icon) |
| 为marker设置阴影效果 |
getShadow( ) |
Icon | 获取marker的阴影图标 |
setShape(shape:MarkerShape) |
| 设置marker的可点击区域 |
getShape( ) |
MarkerShape | 获取marker的可点击区域 |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如Marker的id等 |
getExtData( ) |
Any | 获取用户自定义属性 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 鼠标右键单击事件 |
mousemove |
MapsEvent | 鼠标移动 |
mouseover |
MapsEvent | 鼠标移近点标记时触发事件 |
mouseout |
MapsEvent | 鼠标移出点标记时触发事件 |
mousedown |
MapsEvent | 鼠标在点标记上按下时触发事件 |
mouseup |
MapsEvent | 鼠标在点标记上按下后抬起时触发事件 |
dragstart |
MapsEvent | 开始拖拽点标记时触发事件 |
dragging |
MapsEvent | 鼠标拖拽移动点标记时触发事件 |
dragend |
MapsEvent | 点标记拖拽移动结束触发事件 |
moving |
Object | 点标记在执行moveTo,moveAlong动画时触发事件,Object对象的格式是{passedPath:Array.<LngLat>}。其中passedPath为Marker对象在moveAlong或者moveTo过程中已经走过的路径。 |
moveend |
| 点标记执行moveTo动画结束时触发事件,也可以由moveAlong方法触发 |
movealong |
| 点标记执行moveAlong动画一次后触发事件 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchmove |
MapsEvent | 触摸移动进行中时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
MarkerShape
MarkerShape用于划定Marker的可点击区域范围。自定义区域和Marker重叠的部分,可以触发Marker的点击事件。需要注意的是,在IE浏览器中图标透明区域默认为不触发事件,因此MarkerShape在IE中不起作用。
构造函数 | 说明 |
---|---|
AMap.MarkerShape(opt:MarkerShapeOptions) | 构造一个Marker可点击区域对象,通过MarkerShapeOptions设置可点击区域属性 |
MarkerShapeOptions | 类型 | 说明 |
---|---|---|
coords |
Array.<Number> |
可点击区域组成元素数组,存放图形的像素坐标等信息,该数组元素由type决定: - circle:coords格式为 [x1, y1, r],x1,y1为圆心像素坐标,r为圆半径 - poly: coords格式为 [x1, y1, x2, y2 … xn, yn],各x,y表示多边形边界像素坐标 - rect: coords格式为 [x1, y1, x2, y2],x1,y1为矩形左上角像素坐标,x2,y2为矩形右下角像素坐标 Markshape的像素坐标是指相对于marker的左上角的像素坐标偏移量 |
type |
String |
可点击区域类型,可选值: - circle:圆形 - poly:多边形 - rect:矩形 |
Icon类
表示点标记的图标
用于添加复杂点标记,即在普通点标记的基础上,添加Icon类,通过在Icon表示的大图上截取其中一部分作为标注的图标
相关示例构造函数 | 说明 |
---|---|
AMap.Icon(opt:IconOptions) | 构造点覆盖物图标,通过IconOptions设置图标属性 |
方法 | 返回值 | 说明 |
---|---|---|
getImageSize( ) |
Size | 获取图标图片大小 |
setImageSize(size:Size) |
| 设置图标图片大小 |
ElasticMarker
灵活点标记,一种可以随着地图级别变化而改变图标和大小的点标记,插件类。查看示例
构造函数 | 说明 |
---|---|
AMap.ElasticMarker(opt:ElasticMarkerOptions) | 构造一个灵活点标记对象,通过ElasticMarkerOptions设置点标记对象的属性 |
ElasticMarkerOptions | 类型 | 说明 |
---|---|---|
styles |
Array |
多个不同样式的数组,每个样式形如:
{ icon:{ img:'./a,png', size:[16,16],//图标的原始大小 ancher:[8,16],//锚点,图标原始大小下锚点所处的位置,相对左上角 imageOffset:[360,340], //可缺省,当使用精灵图时可用,标示图标在整个图片中左上角的位置 imageSize:[512,512], //可缺省,当使用精灵图时可用,整张图片的大小 fitZoom:14,//最合适的级别,在此级别下显示为原始大小 scaleFactor:2,//地图放大一级的缩放比例系数 maxScale:2,//最大放大比例 minScale:1//最小放大比例 }, label:{ content:'标记1',//文本内容 position:'BM',//文本位置相对于图标的基准点, //BL、BM、BR、ML、MR、TL、TM、TR分别代表左下角、底部中央、右下角、 //左侧中央、右侧中央、左上角、顶部中央、右上角。 //缺省时代表相对图标的锚点位置 offset:[-35,0],//相对position的偏移量 minZoom:15//label的最小显示级别 } } |
zoomStyleMapping |
Object |
表示地图级别与styles中样式对应关系的映射,如:{ 14:0, 15:0, 16:1, 17:1, 18:1, 19:1, 20:1 }表示14到15级使用styles中的第0个样式,16-20级使用第二个样式 |
map |
Map | 要显示该标记的地图对象 |
position |
LngLat | 点标记在地图上显示的位置,默认为地图中心点 |
topWhenClick |
Boolean | 鼠标点击时marker是否置顶,默认false ,不置顶
(自v1.3 新增) |
bubble |
Boolean | 是否将覆盖物的鼠标或touch等事件冒泡到地图上
(自v1.3 新增) 默认值:false |
draggable |
Boolean | 设置点标记是否可拖拽移动,默认为false |
cursor |
String | 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor |
visible |
Boolean | 点标记是否可见,默认为true |
zIndex |
Number |
点标记的叠加顺序。地图上存在多个点标记叠加时,通过该属性使级别较高的点标记在上层显示 默认zIndex:100 |
clickable |
Boolean | 点标记是否可点击 |
extData |
Any | 用户自定义属性,支持JavaScript API任意数据类型,如Marker的id等 |
方法 | 返回值 | 说明 |
---|---|---|
markOnAMAP(obj:Object) | 唤起高德地图客户端标注页 其中Object里面包含有{ name:String,name属性 必要参数 position: LngLat 坐标点 } | |
setClickable(clickable:Boolean
) |
| 设置点标记是支持鼠标单击事件 |
getClickable( ) |
Boolean | 获取点标记是否支持鼠标单击事件 |
getPosition( ) |
LngLat | 获取点标记的位置 |
setPosition(lnglat:LngLat) |
| 设置点标记位置 |
setzIndex(index:Number) |
| 设置点标记的叠加顺序,默认最先添加的点标记在最底层 |
getzIndex() |
Number | 获取点标记的叠加顺序 |
setDraggable(draggable:Boolean) |
| 设置点标记对象是否可拖拽移动 |
getDraggable( ) |
Boolean | 获取点标记对象是否可拖拽移动 |
hide( ) |
| 点标记隐藏 |
show( ) |
| 点标记显示 |
setCursor(Cursor) |
String |
设置鼠标悬停时的光标。 参数cur可为CSS标注中的光标样式,如:
setCursor(“pointer”)等;或者自定义的光标样式,如: setCursor("url('https://webapi.amap.com/images/0.png') ,pointer") 注:当浏览器不支持css2,url值不起作用,鼠标样式就按pointer来设置 |
setMap(map:Map) |
| 为Marker指定目标显示地图。当参数值取null时,地图上移除当前Marker:setMap(null) |
getMap() |
Map | 获取Marker所在地图对象 |
setTitle(title:String) |
| 鼠标滑过点标时的文字提示 |
getTitle( ) |
String | 获取点标记的文字提示 |
setTop(isTop:Boolean) |
| 地图上有多个marker时,当isTop为true时,marker将显示在最前面;当为false时,marker取消置顶 |
getTop( ) |
Boolean | |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如Marker的id等 |
getExtData( ) |
Any | 获取用户自定义属性 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 鼠标右键单击事件 |
mousemove |
MapsEvent | 鼠标移动 |
mouseover |
MapsEvent | 鼠标移近点标记时触发事件 |
mouseout |
MapsEvent | 鼠标移出点标记时触发事件 |
mousedown |
MapsEvent | 鼠标在点标记上按下时触发事件 |
mouseup |
MapsEvent | 鼠标在点标记上按下后抬起时触发事件 |
dragstart |
MapsEvent | 开始拖拽点标记时触发事件 |
dragging |
MapsEvent | 鼠标拖拽移动点标记时触发事件 |
dragend |
MapsEvent | 点标记拖拽移动结束触发事件 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchmove |
MapsEvent | 触摸移动进行中时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
Text类
纯文本标记,继承自Marker,具有Marker的大部分属性、方法和事件(v1.4.2新增)
构造函数 | 说明 |
---|---|
AMap.Text(opt:TextOptions) | 构造一个点标记对象,通过TextOptions设置点标记对象的属性 |
TextOptions | 类型 | 说明 |
---|---|---|
text |
String | 标记显示的文本内容 |
map |
Map | 要显示该标记的地图对象 |
position |
LngLat | 点标记在地图上显示的位置,默认为地图中心点 |
anchor |
String |
设置文本标记锚点。
默认值:'center' 可选值:'top-left'|'top-center'|'top-right'|'middle-left'|'center'|'middle-right'|'bottom-left'|'bottom-center'|'bottom-right' (自v1.4.13 新增) |
offset |
Pixel | 点标记显示位置偏移量,默认值为Pixel(0,0)。Text指定position后,默认以Text中心位置为基准点(若设置了anchor,则以anchor设置位置为基准点),对准所给定的position位置,若需使Text指定位置对准在position处,需根据Text的尺寸设置一定的偏移量。 |
topWhenClick |
Boolean | 鼠标点击时是否置顶,默认false ,不置顶 |
bubble |
Boolean | 是否将覆盖物的鼠标或touch等事件冒泡到地图上
默认值:false |
draggable |
Boolean | 设置点标记是否可拖拽移动,默认为false |
raiseOnDrag |
Boolean | 设置拖拽点标记时是否开启点标记离开地图的效果 |
cursor |
String | 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor |
visible |
Boolean | 点标记是否可见,默认为true |
zIndex |
Number |
点标记的叠加顺序。地图上存在多个点标记叠加时,通过该属性使级别较高的点标记在上层显示 默认zIndex:100 |
angle |
Number |
点标记的旋转角度,广泛用于改变车辆行驶方向 注:angle属性是使用CSS3来实现的,支持IE9及以上版本 |
autoRotation |
Boolean |
是否自动旋转。点标记在使用moveAlong动画时,路径方向若有变化,点标记是否自动调整角度,默认为false。广泛用于自动调节车辆行驶方向。 IE8以下不支持旋转,autoRotation属性无效 |
animation |
String |
点标记的动画效果,默认值: “AMAP_ANIMATION_NONE” 可选值: “AMAP_ANIMATION_NONE”,无动画效果 “AMAP_ANIMATION_DROP”,点标掉落效果 “AMAP_ANIMATION_BOUNCE”,点标弹跳效果 |
shadow |
Icon | 点标记阴影,不设置该属性则点标记无阴影 |
title |
String | 鼠标滑过点标记时的文字提示,不设置则鼠标滑过点标无文字提示 |
clickable |
Boolean | 点标记是否可点击 |
extData |
Any | 用户自定义属性,支持JavaScript API任意数据类型,如Marker的id等 |
方法 | 返回值 | 说明 |
---|---|---|
getText() |
String | 获取文本内容 |
setText(String) | 修改文本内容 | |
setStyle(Object) | 设置文本样式,Object同css样式表,如:{'background-color':'red'} | |
markOnAMAP(obj:Object) | 唤起高德地图客户端标注页 其中Object里面包含有{ name:String,name属性 必要参数 position: LngLat 坐标点 } | |
getAnchor( ) |
String | 获取Text锚点
(自v1.4.13 新增) |
setAnchor(anchor:String) |
| 设置Text锚点
可选值:'top-left'|'top-center'|'top-right'|'middle-left'|'center'|'middle-right'|'bottom-left'|'bottom-center'|'bottom-right' (自v1.4.13 新增) |
getOffset( ) |
Pixel | 获取偏移量 |
setOffset(offset:Pixel) |
| 设置偏移量 |
setAnimation(animate:String
) |
|
设置点标记的动画效果,默认值: “AMAP_ANIMATION_NONE” 可选值: “AMAP_ANIMATION_NONE”,无动画效果 “AMAP_ANIMATION_DROP”,点标掉落效果 “AMAP_ANIMATION_BOUNCE”,点标弹跳效果 |
getAnimation( ) |
String
| 获取点标记的动画效果类型 |
setClickable(clickable:Boolean
) |
| 设置点标记是支持鼠标单击事件 |
getClickable( ) |
Boolean | 获取点标记是否支持鼠标单击事件 |
getPosition( ) |
LngLat | 获取点标记的位置 |
setPosition(lnglat:LngLat) |
| 设置点标记位置 |
setAngle(angle:Number) |
| 设置点标记的旋转角度 |
getAngle() |
Number | 获取点标记的旋转角度 |
setzIndex(index:Number) |
| 设置点标记的叠加顺序,默认最先添加的点标记在最底层 |
getzIndex() |
Number | 获取点标记的叠加顺序 |
setDraggable(draggable:Boolean) |
| 设置点标记对象是否可拖拽移动 |
getDraggable( ) |
Boolean | 获取点标记对象是否可拖拽移动 |
hide( ) |
| 点标记隐藏 |
show( ) |
| 点标记显示 |
setCursor(Cursor) |
String |
设置鼠标悬停时的光标。 参数cur可为CSS标注中的光标样式,如:
setCursor(“pointer”)等;或者自定义的光标样式,如: setCursor("url('https://webapi.amap.com/images/0.png') ,pointer") 注:当浏览器不支持css2,url值不起作用,鼠标样式就按pointer来设置 |
moveAlong(path:Array, |
|
以指定的速度,点标记沿指定的路径移动。参数path为路径坐标串;speed为指定速度,单位:千米/小时,不可为0; 回调函数f为变化曲线函数,缺省为function(k){return k};参数circlable表明是否循环执行动画,默认为false |
moveTo(lnglat:LngLat,speed:Number, |
| 以给定速度移动点标记到指定位置。参数lnglat为指定位置,必设;speed为指定速度,单位:千米/小时,不可为0;回调函数f为变化曲线函数,缺省为function(k){return k}。 |
stopMove( ) |
| 点标记停止动画 |
pauseMove() |
| 暂定点标记的动画效果 |
resumeMove() |
| 重新开始点标记的动画效果 |
setMap(map:Map) |
| 为Marker指定目标显示地图。当参数值取null时,地图上移除当前Marker:setMap(null) |
getMap() |
Map | 获取Marker所在地图对象 |
setTitle(title:String) |
| 鼠标滑过点标时的文字提示 |
getTitle( ) |
String | 获取点标记的文字提示 |
setTop(isTop:Boolean) |
| 地图上有多个marker时,当isTop为true时,marker将显示在最前面;当为false时,marker取消置顶 |
getTop( ) |
Boolean | |
setShadow(icon:Icon) |
| 设置阴影效果 |
getShadow( ) |
Icon | 获取阴影图标 |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如Marker的id等 |
getExtData( ) |
Any | 获取用户自定义属性 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 鼠标右键单击事件 |
mousemove |
MapsEvent | 鼠标移动 |
mouseover |
MapsEvent | 鼠标移近点标记时触发事件 |
mouseout |
MapsEvent | 鼠标移出点标记时触发事件 |
mousedown |
MapsEvent | 鼠标在点标记上按下时触发事件 |
mouseup |
MapsEvent | 鼠标在点标记上按下后抬起时触发事件 |
dragstart |
MapsEvent | 开始拖拽点标记时触发事件 |
dragging |
MapsEvent | 鼠标拖拽移动点标记时触发事件 |
dragend |
MapsEvent | 点标记拖拽移动结束触发事件 |
moving |
Object | 点标记在执行moveTo,moveAlong动画时触发事件,Object对象的格式是{passedPath:Array.<LngLat>}。其中passedPath为Marker对象在moveAlong或者moveTo过程中已经走过的路径。 |
moveend |
| 点标记执行moveTo动画结束时触发事件,也可以由moveAlong方法触发 |
movealong |
| 点标记执行moveAlong动画一次后触发事件 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchmove |
MapsEvent | 触摸移动进行中时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
Polyline类
覆盖物>折线
构造函数 | 说明 |
---|---|
AMap.Polyline(opt:PolylineOptions) | 构造折线对象,通过PolylineOptions指定折线样式 |
PolylineOptions | 类型 | 说明 |
---|---|---|
map |
Map | 要显示该polyline的地图对象 |
zIndex |
Number |
折线覆盖物的叠加顺序。默认叠加顺序,先添加的线在底层,后添加的线在上层。通过该属性可调整叠加顺序,使级别较高的折线覆盖物在上层显示 默认zIndex:50 |
bubble |
Boolean | 是否将覆盖物的鼠标或touch等事件冒泡到地图上
(自v1.3 新增) 默认值:false |
cursor |
String | 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor |
geodesic |
Boolean | 是否绘制成大地线,默认false相关示例 |
isOutline |
Boolean | 线条是否带描边,默认false |
borderWeight |
Number | 描边的宽度,默认为1 |
outlineColor |
String | 线条描边颜色,此项仅在isOutline为true时有效,默认:#000000 |
path |
Array | 折线的节点坐标数组 |
strokeColor |
String | 线条颜色,使用16进制颜色代码赋值。默认值为#006600 |
strokeOpacity |
Number | 线条透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
strokeWeight |
Number | 线条宽度,单位:像素 |
strokeStyle |
String | 线样式,实线:solid,虚线:dashed |
strokeDasharray |
Array |
勾勒形状轮廓的虚线和间隙的样式,此属性在strokeStyle 为dashed 时有效, 此属性在ie9+浏览器有效 取值:
实线:[0,0,0] 虚线:[10,10] ,[10,10] 表示10个像素的实线和10个像素的空白(如此反复)组成的虚线 点画线:[10,2,10], [10,2,10] 表示10个像素的实线和2个像素的空白 + 10个像素的实线和10个像素的空白 (如此反复)组成的虚线 |
lineJoin |
String | 折线拐点的绘制样式,默认值为'miter'尖角,其他可选值:'round'圆角、'bevel'斜角 |
lineCap |
String | 折线两端线帽的绘制样式,默认值为'butt'无头,其他可选值:'round'圆头、'square'方头 |
draggable |
Boolean | 设置折线是否可拖拽移动,默认为false |
extData |
Any | 用户自定义属性,支持JavaScript API任意数据类型,如Polyline的id等 |
showDir |
Boolean | 是否延路径显示白色方向箭头,默认false。Canvas绘制时有效,建议折线宽度大于6时使用;在3D视图下不支持显示方向箭头(自V1.4.0版本参数效果变更) |
方法 | 返回值 | 说明 |
---|---|---|
setPath(path:Array) |
| 设置组成该折线的节点数组 |
getPath( ) |
Array | 获取折线路径的节点数组。其中lat和lng是经纬度参数。 |
setOptions(opt:PolylineOptions) |
| 修改折线属性(包括路径的节点、线样式、是否绘制大地线等。属性详情参看PolylineOptions列表) |
getOptions( ) |
Object | 获取线的属性 |
getLength( ) |
Number | 获取折线的总长度(单位:米) |
getBounds( ) |
Bounds | 获取当前折线的矩形范围对象 |
hide( ) |
| 地图上隐藏指定折线 |
show( ) |
| 地图上显示指定折线 |
setMap(map:Map) |
| 设置折线所在的地图。参数map即为目标地图,参数为null时,在地图上移除当前折线 |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如Polyline的id等 |
getExtData( ) |
Any | 获取用户自定义属性 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 鼠标右键单击事件 |
hide |
{type, target} | 隐藏 |
show |
{type, target} | 显示 |
mousedown |
MapsEvent | 鼠标按下 |
mouseup |
MapsEvent | 鼠标抬起 |
mouseover |
MapsEvent | 鼠标经过 |
mouseout |
MapsEvent | 鼠标移出 |
change |
| 属性发生变化时 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchmove |
MapsEvent | 触摸移动进行中时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
Polygon类
覆盖物>多边形
构造函数 | 说明 |
---|---|
AMap.Polygon(opt:PolygonOptions) | 构造多边形对象,通过PolygonOptions指定多边形样式 |
PolygonOptions | 类型 | 说明 |
---|---|---|
map |
Map | 要显示该polygon的地图对象 |
zIndex |
Number |
多边形覆盖物的叠加顺序。地图上存在多个多边形覆盖物叠加时,通过该属性使级别较高的多边形覆盖物在上层显示 默认zIndex:10 |
path |
Array.<LngLat>|Array.<Array.<LngLat>> |
多边形轮廓线的节点坐标数组,当为“环”多边形时(多边形区域在多边形内显示为“岛”),path为二维数组,数组元素为多边形轮廓线的节点坐标数组 “环”多边形时,要求数组第一个元素为外多边形,其余为“岛”多边形,外多边形需包含“岛”多边形,否则程序不作处理 |
bubble |
Boolean | 是否将覆盖物的鼠标或touch等事件冒泡到地图上
(自v1.3 新增) 默认值:false |
cursor |
String | 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor |
strokeColor |
String | 线条颜色,使用16进制颜色代码赋值。默认值为#006600 |
strokeOpacity |
float | 轮廓线透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
strokeWeight |
Number | 轮廓线宽度 |
fillColor |
String | 多边形填充颜色,使用16进制颜色代码赋值,如:#FFAA00 |
fillOpacity |
Float | 多边形填充透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
draggable |
Boolean | 设置多边形是否可拖拽移动,默认为false |
extData |
Any | 用户自定义属性,支持JavaScript API任意数据类型,如Polygon的id等 |
strokeStyle |
String | 轮廓线样式,实线:solid,虚线:dashed |
strokeDasharray |
Array |
勾勒形状轮廓的虚线和间隙的样式,此属性在strokeStyle 为dashed 时有效, 此属性在ie9+浏览器有效 取值:
实线:[0,0,0] 虚线:[10,10] ,[10,10] 表示10个像素的实线和10个像素的空白(如此反复)组成的虚线 点画线:[10,2,10], [10,2,10] 表示10个像素的实线和2个像素的空白 + 10个像素的实线和10个像素的空白 (如此反复)组成的虚线 |
方法 | 返回值 | 说明 |
---|---|---|
setPath(path:Array.<LngLat>|Array.<Array.<LngLat>>) |
| 设置多边形轮廓线节点数组,当为“环”多边形时,path为二维数组,数组元素为多边形轮廓线的节点坐标数组 |
getPath( ) |
array | 获取多边形轮廓线节点数组。其中lat和lng是经纬度参数。 |
setOptions(opt:PolygonOptions) |
| 修改多边形属性(样式风格,包括组成多边形轮廓线的节点、轮廓线样式等。属性详情参看PolygonOptions列表) |
getOptions( ) |
object | 获取多边形的属性 |
getBounds( ) |
Bounds |
获取当前多边形的矩形范围对象。
(自v1.2 新增) |
getArea( ) |
Number |
获取多边形的面积(单位:平方米)
(自v1.1 新增) |
hide( ) |
| 隐藏多边形 |
show( ) |
| 显示多边形 |
setMap(map:Map) |
|
在指定地图上显示当前的多边形。参数取值为null时,在地图上移除当前多边形
(自v1.2 新增) |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如Polygon的id等 |
getExtData( ) |
Any | 获取用户自定义属性 |
contains(point:LngLat) |
Boolean | 判断指定点坐标是否在多边形范围内 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 右键单击 |
hide |
{type, target} | 隐藏 |
show |
{type, target} | 显示 |
mousedown |
MapsEvent | 鼠标按下 |
mouseup |
MapsEvent | 鼠标抬起 |
mouseover |
MapsEvent | 鼠标经过 |
mouseout |
MapsEvent | 鼠标移出 |
change |
| 属性发生变化时 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchmove |
MapsEvent | 触摸移动进行中时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
BezierCurve类
贝瑟尔曲线类(v1.4.2新增),前往示例
构造函数 | 说明 |
---|---|
| 用于创建曲线,ops为初始化构造参数 |
BezierCurveOptions | 类型 | 说明 |
---|---|---|
|
| 贝瑟尔曲线的路径。描述为一个二维数组规则如下:第一个元素是起点, 之后的元素同时描述控制点和途经点,之后每个元素可以有0个到2个控制点 控制点在前,途经点在最后 [ [lng,lat],//起点0 [lng,lat,lng,lat],//控制点、途经点1 [lng,lat,lng,lat,lng,lat],//控制点、控制点、途经点2 [lng,lat,lng,lat]//控制点、途经点3 ] 或者 [ [ [lng,lat] ],//起点0 [ [lng,lat] , [lng,lat] ],//控制点、途经点1 [ [lng,lat] , [lng,lat] , [lng,lat]],//控制点、控制点、途经点2 [ [lng,lat] , [lng,lat] ]//控制点、途经点3 ] |
|
| 所属地图 |
|
| 线条颜色,如‘#000000’、‘red’ |
|
| 透明度 |
|
| 线宽 |
|
| 虚线或者视线,'dashed'、'solid' |
|
| 虚线的分段,如[10,10] |
|
| 层级 |
|
| 是否显示白色方向箭头 |
|
| 事件是否穿透到地图 |
|
|
指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor |
|
| 是否描边 |
|
| 描边颜色 |
|
| 描边宽度 |
方法 | 返回值 | 说明 |
---|---|---|
setPath(path:Array) |
| 设置组成该折线的节点数组 |
getPath( ) |
Array | 获取折线路径的节点数组。其中lat和lng是经纬度参数。 |
setOptions(opt:PolylineOptions) |
| 修改折线属性(包括路径的节点、线样式、是否绘制大地线等。属性详情参看PolylineOptions列表) |
getOptions( ) |
Object | 获取线的属性 |
getLength( ) |
Number | 获取折线的总长度(单位:米) |
getBounds( ) |
Bounds | 获取当前折线的矩形范围对象 |
hide( ) |
| 地图上隐藏指定折线 |
show( ) |
| 地图上显示指定折线 |
setMap(map:Map) |
| 设置折线所在的地图。参数map即为目标地图,参数为null时,在地图上移除当前折线 |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如Polyline的id等 |
getExtData( ) |
Any | 获取用户自定义属性 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 鼠标右键单击事件 |
hide |
{type, target} | 隐藏 |
show |
{type, target} | 显示 |
mousedown |
MapsEvent | 鼠标按下 |
mouseup |
MapsEvent | 鼠标抬起 |
mouseover |
MapsEvent | 鼠标经过 |
mouseout |
MapsEvent | 鼠标移出 |
change |
| 属性发生变化时 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
Circle类
覆盖物>圆
构造函数 | 说明 |
---|---|
AMap.Circle(opt:CircleOptions) | 构造圆形覆盖物,通过CircleOptions设置圆形 |
CircleOptions | 类型 | 说明 |
---|---|---|
map |
Map |
要显示该circle的地图对象
(自v1.2 新增) |
zIndex |
Number |
层叠顺序 默认zIndex:10 |
center |
LngLat | 圆心位置 |
bubble |
Boolean | 是否将覆盖物的鼠标或touch等事件冒泡到地图上
(自v1.3 新增) 默认值:false |
cursor |
String | 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor |
radius |
Number | 圆半径,单位:米 |
strokeColor |
String | 线条颜色,使用16进制颜色代码赋值。默认值为#006600 |
strokeOpacity |
Float | 轮廓线透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
strokeWeight |
Number | 轮廓线宽度 |
fillColor |
String | 圆形填充颜色,使用16进制颜色代码赋值。默认值为#006600 |
fillOpacity |
Float | 圆形填充透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
strokeStyle |
String | 轮廓线样式,实线:solid,虚线:dashed |
extData |
Any | 用户自定义属性,支持JavaScript API任意数据类型,如Circle的id等 |
strokeDasharray |
Array |
勾勒形状轮廓的虚线和间隙的样式,此属性在strokeStyle 为dashed 时有效, 此属性在ie9+浏览器有效 取值:
实线:[0,0,0] 虚线:[10,10] ,[10,10] 表示10 个像素的实线和10 个像素的空白(如此反复)组成的虚线 点画线:[10,2,10], [10,2,10] 表示10 个像素的实线和2 个像素的空白 + 10 个像素的实线和10 个像素的空白 (如此反复)组成的虚线 |
方法 | 返回值 | 说明 |
---|---|---|
setCenter(lnglat:LngLat) |
| 设置圆中心点 |
getCenter( ) |
LngLat | 获取圆中心点 |
getBounds( ) |
Bounds | 获取圆外切矩形范围 |
setRadius(radius:Number) |
| 设置圆形的半径 |
getRadius( ) |
Number | 获取圆形的半径 |
setOptions(circleopt:CircleOptions) |
| 修改圆属性(样式风格,包括组成圆形轮廓线的节点、轮廓线样式等。属性详情参看CircleOptions列表) |
getOptions( ) |
Object | 获取圆形的属性 |
hide( ) |
| 地图上隐藏圆形 |
show( ) |
| 地图上显示圆形 |
setMap(map:Map) |
|
在指定地图上添加该圆形覆盖物。参数取值为null时,在地图上移除当前圆形
(自v1.2 新增) |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如Circle的id等 |
getExtData( ) |
Any | 获取用户自定义属性 |
contains(point:LngLat) |
Boolean | 判断指定点坐标是否在圆内 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 右键单击 |
hide |
{type, target} | 隐藏 |
show |
{type, target} | 显示 |
mousedown |
MapsEvent | 鼠标按下 |
mouseup |
MapsEvent | 鼠标抬起 |
mouseover |
MapsEvent | 鼠标经过 |
mouseout |
MapsEvent | 鼠标移出 |
change |
{type, target} | 属性发生变化时 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchmove |
MapsEvent | 触摸移动进行中时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
CircleMarker类
覆盖物>圆点标记,自1.4.3新增,属性和方法于Circle大体一致,区别为CircleMarker不随着地图级别变化发生大小改变,redius的单位为px.示例
构造函数 | 说明 |
---|---|
AMap.CircleMarker(opt:CircleMarkerOptions) | 构造圆点标记,通过CircleMarkerOptions设置圆点标记的属性 |
CircleMarkerOptions | 类型 | 说明 |
---|---|---|
map |
Map |
要显示该标记的地图对象
(自v1.2 新增) |
zIndex |
Number |
层叠顺序 默认zIndex:10 |
center |
LngLat | 圆心位置 |
bubble |
Boolean | 是否将覆盖物的鼠标或touch等事件冒泡到地图上
(自v1.3 新增) 默认值:false |
radius |
Number | 圆点半径,单位:px |
strokeColor |
String | 线条颜色,使用16进制颜色代码赋值。默认值为#006600 |
strokeOpacity |
Float | 轮廓线透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
strokeWeight |
Number | 轮廓线宽度 |
fillColor |
String | 圆形填充颜色,使用16进制颜色代码赋值。默认值为#006600 |
fillOpacity |
Float | 圆形填充透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
extData |
Any | 用户自定义属性,支持JavaScript API任意数据类型,如Circle的id等 |
方法 | 返回值 | 说明 |
---|---|---|
setCenter(lnglat:LngLat) |
| 设置圆点中心 |
getCenter( ) |
LngLat | 获取圆点中心 |
setRadius(radius:Number) |
| 设置圆点的半径 |
getRadius( ) |
Number | 获取圆点的半径 |
setOptions(circleopt:CircleMarkerOptions) |
| 修改圆点标记的属性(样式风格,包括轮廓线、填充色等。属性详情参看CircleMarkerOptions列表) |
getOptions( ) |
Object | 获取圆点的属性 |
hide( ) |
| 地图上隐藏圆形 |
show( ) |
| 地图上显示圆形 |
setMap(map:Map) |
|
在指定地图上添加该圆点覆盖物。参数取值为null时,在地图上移除当前圆形
(自v1.2 新增) |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如CircleMarker的id等 |
getExtData( ) |
Any | 获取用户自定义属性 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 右键单击 |
hide |
{type, target} | 隐藏 |
show |
{type, target} | 显示 |
mousedown |
MapsEvent | 鼠标按下 |
mouseup |
MapsEvent | 鼠标抬起 |
mouseover |
MapsEvent | 鼠标经过 |
mouseout |
MapsEvent | 鼠标移出 |
change |
{type, target} | 属性发生变化时 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchmove |
MapsEvent | 触摸移动进行中时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
Ellipse类
椭圆(v1.4.2新增)
构造函数 | 说明 |
---|---|
AMap.Ellipse(opt:EllipseOptions) | 构造椭圆覆盖物,通过EllipseOptions设置椭圆 |
EllipseOptions | 类型 | 说明 |
---|---|---|
map |
Map | 要显示该ellipse的地图对象 |
zIndex |
Number |
层叠顺序 默认zIndex:10 |
center |
LngLat | 椭圆的圆心位置 |
radius |
Array |
椭圆的半径,用2个元素的数组表示,单位:米 如: radius: [1000, 2000] 表示横向半径是1000,纵向的半径是2000 默认值:[1000, 1000] |
bubble |
Boolean | 是否将覆盖物的鼠标或touch等事件冒泡到地图上
默认值:false |
cursor |
String | 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor |
strokeColor |
String | 线条颜色,使用16进制颜色代码赋值。默认值为#006600 |
strokeOpacity |
Float | 轮廓线透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
strokeWeight |
Number | 轮廓线宽度 |
fillColor |
String | 椭圆填充颜色,使用16进制颜色代码赋值。默认值为#006600 |
fillOpacity |
Float | 椭圆填充透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
strokeStyle |
String | 轮廓线样式,实线:solid,虚线:dashed |
extData |
Any | 用户自定义属性,支持JavaScript API任意数据类型,如Ellipse的id等 |
strokeDasharray |
Array |
勾勒形状轮廓的虚线和间隙的样式,此属性在strokeStyle 为dashed 时有效, 此属性在ie9+浏览器有效 取值:
实线:[0,0,0] 虚线:[10,10] ,[10,10] 表示10 个像素的实线和10 个像素的空白(如此反复)组成的虚线 点画线:[10,2,10], [10,2,10] 表示10 个像素的实线和2 个像素的空白 + 10 个像素的实线和10 个像素的空白 (如此反复)组成的虚线 |
方法 | 返回值 | 说明 |
---|---|---|
getCenter() |
LngLat | 获取椭圆的中心点 |
setCenter(lnglat: LngLat) | 设置椭圆的中心点 | |
getBounds() |
Bounds | 获取椭圆范围 |
setOptions(ellipseOpt:EllipseOptions) |
| 修改椭圆属性(样式风格,包括组成椭圆轮廓线的节点、轮廓线样式等。属性详情参看EllipseOptions列表) |
getOptions() |
Object | 获取椭圆的属性 |
hide() |
| 地图上隐藏椭圆 |
show() |
| 地图上显示椭圆 |
setMap(map:Map) |
| 在指定地图上添加该椭圆覆盖物。参数取值为null时,在地图上移除当前椭圆 |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如Ellipse的id等 |
getExtData() |
Any | 获取用户自定义属性 |
contains(point:LngLat) |
Boolean | 判断指定点坐标是否在椭圆内 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 右键单击 |
hide |
{type, target} | 隐藏 |
show |
{type, target} | 显示 |
mousedown |
MapsEvent | 鼠标按下 |
mouseup |
MapsEvent | 鼠标抬起 |
mouseover |
MapsEvent | 鼠标经过 |
mouseout |
MapsEvent | 鼠标移出 |
change |
{type, target} | 属性发生变化时 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchmove |
MapsEvent | 触摸移动进行中时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
Rectangle类
矩形(v1.4.2新增)
构造函数 | 说明 |
---|---|
AMap.Rectangle(opt:RectangleOptions) | 构造矩形覆盖物,通过RectangleOptions设置矩形 |
RectangleOptions | 类型 | 说明 |
---|---|---|
map |
Map | 要显示该rectangle的地图对象 |
zIndex |
Number |
层叠顺序 默认zIndex:10 |
bounds |
Bounds | 矩形的范围 |
bubble |
Boolean | 是否将覆盖物的鼠标或touch等事件冒泡到地图上
默认值:false |
cursor |
String | 指定鼠标悬停时的鼠标样式,自定义cursor,IE仅支持cur/ani/ico格式,Opera不支持自定义cursor |
strokeColor |
String | 线条颜色,使用16进制颜色代码赋值。默认值为#006600 |
strokeOpacity |
Float | 轮廓线透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
strokeWeight |
Number | 轮廓线宽度 |
fillColor |
String | 矩形填充颜色,使用16进制颜色代码赋值。默认值为#006600 |
fillOpacity |
Float | 矩形填充透明度,取值范围[0,1],0表示完全透明,1表示不透明。默认为0.9 |
strokeStyle |
String | 轮廓线样式,实线:solid,虚线:dashed |
extData |
Any | 用户自定义属性,支持JavaScript API任意数据类型,如Rectangle的id等 |
strokeDasharray |
Array |
勾勒形状轮廓的虚线和间隙的样式,此属性在strokeStyle 为dashed 时有效, 此属性在ie9+浏览器有效 取值:
实线:[0,0,0] 虚线:[10,10] ,[10,10] 表示10 个像素的实线和10 个像素的空白(如此反复)组成的虚线 点画线:[10,2,10], [10,2,10] 表示10 个像素的实线和2 个像素的空白 + 10 个像素的实线和10 个像素的空白 (如此反复)组成的虚线 |
方法 | 返回值 | 说明 |
---|---|---|
getBounds() |
Bounds | 获取矩形范围 |
setBounds(bounds:Bounds) |
| 设置矩形的范围 |
setOptions(rectangleopt:RectangleOptions) |
| 修改矩形属性(样式风格,包括组成矩形轮廓线的节点、轮廓线样式等。属性详情参看RectangleOptions列表) |
getOptions() |
Object | 获取矩形的属性 |
hide() |
| 地图上隐藏矩形 |
show() |
| 地图上显示矩形 |
setMap(map:Map) |
| 在指定地图上添加该矩形覆盖物。参数取值为null时,在地图上移除当前矩形 |
setExtData(ext:Any) |
| 设置用户自定义属性,支持JavaScript API任意数据类型,如Rectangle的id等 |
getExtData() |
Any | 获取用户自定义属性 |
contains(point:LngLat) |
Boolean | 判断指定点坐标是否在矩形内 |
事件 | 参数 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
rightclick |
MapsEvent | 右键单击 |
hide |
{type, target} | 隐藏 |
show |
{type, target} | 显示 |
mousedown |
MapsEvent | 鼠标按下 |
mouseup |
MapsEvent | 鼠标抬起 |
mouseover |
MapsEvent | 鼠标经过 |
mouseout |
MapsEvent | 鼠标移出 |
change |
{type, target} | 属性发生变化时 |
touchstart |
MapsEvent | 触摸开始时触发事件,仅适用移动设备 |
touchmove |
MapsEvent | 触摸移动进行中时触发事件,仅适用移动设备 |
touchend |
MapsEvent | 触摸结束时触发事件,仅适用移动设备 |
OverlayGroup类
OverlayGroup类用来包装其它覆盖物类的实例,对实例集合做整体操作,避免开发者对多个需要设置同样属性的覆盖物实例做循环处理。同时只要对OverlayGroup执行过setMap方法后,新添加到该OverlayGroup中的覆盖物会自动将其map属性修改到该group对应的map,此外从group中移除该覆盖物时,也会将该覆盖物从group对应的map中移除。
目前OverlayGroup支持Marker, Polygon, Polyline, Circle, Rectangle, Ellipse 和 BezierCurve。
构造函数 | 说明 |
---|---|
AMap.OverlayGroup(overlays: Array | 构造覆盖物集合,传入的参数是一个覆盖物实例的数组 |
方法 | 返回值 | 说明 |
---|---|---|
addOverlay(overlay: Overlay) | 添加单个覆盖物到集合中,不支持添加重复的覆盖物 | |
addOverlays(overlays: Array |
| 添加覆盖物数组到集合中,不支持添加重复的覆盖物 |
getOverlays() |
Array | 返回当前集合中所有的覆盖物 |
hasOverlay(overlay: Overlay) |
Boolean | 判断传入的覆盖物实例是否在集合中 |
removeOverlay(overlay: Overlay) |
| 从集合中删除传入的覆盖物实例 |
removeOverlays(overlays: Array |
| 从集合中删除传入的覆盖物实例数组 |
clearOverlays() |
| 清空集合 |
eachOverlay(iterator: Function) |
|
对集合中的覆盖物做迭代操作,其中iterator的函数定义是:
function(overlay, index, collections),相关含义如下: overlay: 当前迭代到的覆盖物 index: 该覆盖物在集合中的序列号(从0开始) collections: 所有覆盖物实例 |
setMap(map: Map) |
Boolean | 指定集合中里覆盖物的显示地图 |
setOptions(opt: OverlayOptions) |
| 修改覆盖物属性(包括线样式、样色等等) |
show() |
| 在地图上显示集合中覆盖物 |
hide() |
| 在地图上隐藏集合中覆盖物 |
事件 | 说明 |
---|---|
集合中对应覆盖物支持的事件 | 如果对覆盖物集合添加对某个事件的监听或解除监听, 覆盖物集合会对集合中所有覆盖物实例做集合处理, 只要该覆盖物支持此事件, 该事件绑定/解除即对覆盖物生效 |
GeoJSON类
GeoJSON类,继承自OverLayGroup,可实现GeoJSON对象与OverlayGroup的相互转换,(v1.4.2新增)
构造函数 | 说明 |
---|---|
| 创建一个GeoJSON对象,ops为初始构造参数 |
GeoJSONOptions | 类型 | 说明 |
---|---|---|
|
| 要加载的标准GeoJSON对象 |
|
| 指定点要素的绘制方式,缺省时为Marker的默认样式。 geojson为当前要素对应的GeoJSON对象,lnglat为对应的点的位置 |
|
| 指定线要素的绘制方式,缺省时为Polyline的默认样式。 geojson为当前要素对应的GeoJSON对象,lnglats为对应的线的路径 |
|
| 指定面要素的绘制方式,缺省时为Polygon的默认样式。 geojson为当前要素对应的GeoJSON对象,lnglats为对应的面的路径 |
方法 | 返回值 | 说明 |
---|---|---|
| 加载新的GeoJSON对象,转化为覆盖物,旧的覆盖物将移除 | |
|
| 将当前对象包含的覆盖物转换为GeoJSON对象 |
| 添加一个覆盖物,如需要在转成GeoJSON的时候将某些信息带给对应GeoJSON对象的properties属性中,可以将信息添加到覆盖物的extData的_geoJsonProperties字段中,如:
| |
| 添加多个覆盖物,说明同 | |
| 获取所有覆盖物 | |
| 是否包含某个覆盖物 | |
| 移除一个覆盖物 | |
| 移除多个覆盖物 | |
| 清空覆盖物 | |
| 遍历覆盖物 | |
| 设置地图 | |
| 显示所有覆盖物 | |
| 隐藏所有覆盖物 |
GroundImage类
图片覆盖物类,用于添加一个只有一张图片的图层,图片会随缩放级别而自适应缩放。自1.3废除
构造函数 | 说明 |
---|---|
AMap.GroundImage(Url:String,bounds:Bounds,opt:GroundImageOptions) | 构造GroundImage对象,需要提供一个图片url,以及它覆盖的Bounds。图片会根据Bounds大小显示 |
GroundImageOptions | 类型 | 说明 |
---|---|---|
map |
Map | 要显示该groundimage的地图对象 |
clickable |
Boolean |
图层是否可点击,若为可点击则GroundImage支持鼠标点击事件 默认值:false |
opacity |
Number |
图片透明度,取值范围[0,1],0表示完全透明,1表示不透明 默认值:1 |
方法 | 返回值 | 说明 |
---|---|---|
getMap( ) |
Map | 获取GroundImage的Map对象 |
setMap(map:Map) |
| 设置显示GroundImage的Map对象 |
getOpacity( ) |
Number | 获取图片透明度值 |
setOpacity(opacity:Number) |
| 设置图片透明度 |
getBounds( ) |
Bounds | 获取GroundImage的覆盖地理范围 |
getImageUrl( ) |
String | 获取图片url |
事件 | 参数值 | 说明 |
---|---|---|
click |
MapsEvent | 鼠标左键单击事件 |
dblclick |
MapsEvent | 鼠标左键双击事件 |
ContextMenu类
地图右键菜单
构造函数 | 说明 |
---|---|
AMap.ContextMenu(opt:ContextMenuOptions) | 构造一个右键菜单对象 |
ContextMenuOptions | 类型 | 说明 |
---|---|---|
position |
LngLat |
右键菜单显示的位置
(自v1.2 废弃) |
content |
String/HTMLELement | 右键菜单内容(针对自定义菜单时,添加菜单内容及功能。可以是HTML要素字符串或者HTML DOM对象。) |
width |
Number |
右键菜单宽度
(自v1.2 废弃) |
方法 | 返回值 | 说明 |
---|---|---|
addItem(text:String,fn:Function,num:Number) |
| 右键菜单中添加菜单项。参数text:菜单显示内容;fn:该菜单下需进行的操作;num:当前菜单项在右键菜单中的排序位置,以0开始 |
removeItem(text:String,fn:Function) |
| 删除一个菜单项 |
open(map:Map,position:LngLat) |
| 在地图的指定位置打开右键菜单。 |
close( ) |
| 关闭右键菜单 |
事件 | 参数 | 说明 |
---|---|---|
open |
{type, target} | 右键菜单打开事件 |
close |
{type, target} | 右键菜单关闭事件 |
LabelMarker 类(自v1.4.14新增)
标注类,支持大量点标注和文本标注的绘制,基于 AMap.LabelsLayer 图层绘制。查看示例。
构造函数 | 说明 |
---|---|
AMap.LabelMarker(opt:LabelMarkerOptions) | 构造一个 LabelMarker 对象,通过 LabelMarkerOptions 设置对象的属性 |
LabelMarkerOptions | 类型 | 说明 |
---|---|---|
position | String | Array | Lnglat | 标注的位置 |
zooms | Array | 标注显示级别范围, 可选值:[3,20] |
opacity | Number | 标注透明度 |
zIndex | Number |
标注叠加顺序 (自v1.4.15 新增) |
rank | Number |
用于避让优先级,数字越大优先级越高,默认值为 1
(自v1.4.15 新增) |
name | string |
该标注的名称,用于标识,非用于显示
(自v1.4.15 新增) |
icon | Object | 配置标注中的图标,Object 取值请参见下方 IconOptions |
text | Object | 配置标注中的文字,Object 取值请参见下方 TextOptions |
IconOptions | 类型 | 说明 |
---|---|---|
image | String | 图标地址 |
size | Size | 图标大小,默认值:[36, 36] |
clipOrigin | Array | Pixel | 图标所用图片偏移量 |
anchor | String | 图标锚点。 可选值: 'top-left'| 'top-center'| 'top-right'| 'middle-left'| 'center'| 'middle-right'| 'bottom-left'| 'bottom-center'| 'bottom-right' 。默认值:'top-left' |
retina | Boolean | 高清屏支持,默认值: true |
TextOptions | 类型 | 说明 |
---|---|---|
content | String | 文字内容 |
direction | String | 相对于图标的方位。 可选值: 'top' 'right' 'bottom' 'left' 'center' 。默认值:'top' |
offset | Array | Pixel | 相对 direction 的位置偏移 |
zooms | Array | 文字显示范围,可选值:[3,20] |
style | Object | 文字样式,Object 取值见下方 StyleOptions |
StyleOptions | 类型 | 说明 |
---|---|---|
fontSize | Number | 文字大小,默认值:12 |
fontFamily (2D) | String | 文字字体 |
fontWeight(2D) | String | 文字粗细。 可选值: 'normal'| 'lighter'| 'bold' 。默认值:'normal' |
fillColor | String | 文字颜色 |
strokeColor | String | 文字描边颜色 |
strokeWidth | Number | 文字描边宽度,注:只有描边颜色没有描边宽度时,默认描边宽度为 1 |
padding |
String | Array | 文字 padding
支持以下几种格式: '5' | '5 10' | '5 10 20' | '5 10 5 10' | [5] | [5, 10] | [5, 10, 5] | [5, 10, 5, 10] 默认值为 [3, 3, 3, 3] (自v1.4.15 新增) |
backgroundColor | String | 文字背景颜色
(自v1.4.15 新增) |
方法 | 返回值 | 说明 |
---|---|---|
getPosition() | LngLat | 获取标注位置 |
setPosition(position: LngLat|Array|string) | 设置标注位置 | |
getName() | string | 获取标注 name 字段 (自v1.4.15 新增) |
setName(name:string) | 设置标注 name 字段 (自v1.4.15 新增) | |
getzIndex() | Number | 获取 LabelMarker 的叠加顺序 (自v1.4.15 新增) |
setzIndex(zIndex: Number) | 设置 LabelMarker 的叠加顺序 (自v1.4.15 新增) | |
getZooms() | Array | 获取显示级别范围 |
setZooms(zooms: Array) | 设置显示级别范围 | |
getOpacity() | Number | 获取透明度 |
setOpacity(opacity: Number) | 设置透明度 | |
getRank() | Number | 获取该标注的避让优先级 (自v1.4.15 新增) |
setRank(rank:number) | 设置该标注的避让优先级 (自v1.4.15 新增) | |
getText() | TextOptions | 获得文字样式和内容 (自v1.4.15 新增) |
setText(text: TextOptions) | 设置文字样式和内容 | |
getIcon() | IconOptions | 获取图标样式 |
setIcon(icon: IconOptions) | 设置图标样式 | |
getVisible() | Boolean | 获取该标注是否可见 (自v1.4.15 新增) |
setTop(isTop: Boolean) | 是否置顶该标注 (自v1.4.15 新增) | |
getExtData() | any | 获取该标注用户自定义数据 (自v1.4.15 新增) |
setExtData(data: any) | 设置该标注用户自定义数据,可为任意类型 (自v1.4.15 新增) | |
getOptions() | LabelMarkerOptions | 获取该标注的所有属性 (自v1.4.15 新增) |
show() | 显示标注 (自v1.4.15 新增) | |
hide() | 隐藏标注 (自v1.4.15 新增) |
事件 | 参数 | 说明 |
---|---|---|
click | {type, target, data, lnglat, pixel} | 鼠标点击事件 |
mouseover | {type, target, data, lnglat, pixel} | 鼠标移入事件 |
mousemove | {type, target, data, lnglat, pixel} | 鼠标在标注上移动事件 |
mouseout | {type, target, data, lnglat, pixel} | 鼠标移出事件 |
mousedown | {type, target, data, lnglat, pixel} | 鼠标点击事件 |
mouseup | {type, target, data, lnglat, pixel} | 鼠标抬起事件 |
touchstart | {type, target, data, lnglat, pixel} | 触摸start事件 |
touchend | {type, target, data, lnglat, pixel} | 触摸end事件 |