核心类

Map
此类是地图API的核心类，用来实例化一个地图。
构造函数
构造函数 描述
Map(container: String | HTMLElement, opts: MapOptions) 在指定的容器内创建地图实例，之后需要调用Map.centerAndZoom()方法对地图进行初始化。未进行初始化的地图将不能进行任何操作
方法
方法 返回值 描述
enableDragging() none 启用地图拖拽，默认启用
disableDragging() none 禁用地图拖拽
enableDoubleClickZoom() none 启用双击放大，默认启用
disableDoubleClickZoom() none 禁用双击放大
enableInertialDragging() none 启用地图惯性拖拽，默认禁用
disableInertialDragging() none 禁用地图惯性拖拽
enablePinchToZoom() none 启用双指操作缩放，默认启用
disablePinchToZoom() none 禁用双指操作缩放
centerAndZoom(center: Point, zoom: Number) none 设初始化地图, zoom可赋值范围为3-18级。
reset() none 重新设置地图，恢复地图初始化时的中心点和级别
getBounds() Bounds 返回地图可视区域，以地理坐标表示
getSize() Size 返回地图视图的大小，以像素表示
getViewport(view: Array<Point> | Bounds, viewportOptions: ViewportOptions) Viewport 根据提供的地理区域或坐标获得最佳的地图视野，返回的对象中包含center和zoom属性，分别表示地图的中心点和级别。此方法仅返回视野信息，不会将新的中心点和级别做用到当前地图上
setViewport(view: Array<Point> | Bounds| Viewport, viewportOptions: ViewportOptions) none 根据提供的地理区域或坐标设置地图视野，调整后的视野会包含提供的地理区域或坐标
panTo(center: Point, opts: PanOptions) none 将地图的中心点更改为给定的点。如果该点在当前的地图视图中已经可见，则会以平滑动画的方式移动到中心点位置。可以通过配置，强制移动过程不使用动画效果
panBy(x: Number, y: Number, opts: PanOptions) none 将地图在水平位置上移动x像素，垂直位置上移动y像素。如果指定的像素大于可视区域范围或者在配置中指定不使用动画效果，则不执行滑动效果
getCenter() Point 返回地图当前中心点
setCenter(center: Point) none 设置地图中心点。
getZoom() Number 返回地图当前缩放级别
setZoom(zoom: Number) none 将视图切换到指定的缩放等级，中心点坐标不变。
zoomIn() none 放大一级视图
zoomOut() none 缩小一级视图
addControl(control: Control) none 将控件添加到地图，一个控件实例只能向地图中添加一次
removeControl(control: Control) none 从地图中移除控件。如果控件从未被添加到地图中，则该移除不起任何作用
addOverlay(overlay: Overlay) none 将覆盖物添加到地图中，一个覆盖物实例只能向地图中添加一次
removeOverlay(overlay: Overlay) none 从地图中移除覆盖物。如果覆盖物从未被添加到地图中，则该移除不起任何作用
clearOverlays() none 清除地图上所有覆盖物
getOverlays() Array< Overlay> 返回地图上的所有覆盖物
addMassFeatures(arrMassFeatures: Array < MassFeature>) none 增加海量覆盖物
removeMassFeatures(arrMassFeatures: Array < MassFeature>) none 移除海量覆盖物
clearMassFeatures() none 清除所有海量覆盖物
pixelToPoint(pixel: Pixel) Point 像素坐标转换为地理坐标
pointToPixel(point: Point) Pixel 地理坐标转换为像素坐标
pointToOverlayPixel(point: Point) Pixel 根据地理坐标获取对应的覆盖物容器的坐标，此方法用于自定义覆盖物
overlayPixelToPoint(pixel: Pixel) Point 根据覆盖物容器的坐标获取对应的地理坐标
getZoomUnits(zoom(可选): Number) Number 获取地图比例尺，即1像素对应多少米
getTileUnits(zoom(可选): Number) Number 瓦块比例尺，即1个网格瓦块对应多少米
addTileLayer(tileLayer: TileLayer) none 添加一个自定义地图图层
removeTileLayer(tileLayer: TileLayer) none 移除一个自定义地图图层
getPanes() MapPanes 返回地图覆盖物容器列表, 自定义覆盖物时候会用到此方法
getContainer() HTMLElement 返回地图的容器元素。当创建用户自定义控件时，需要自行实现Control.initialize()方法，并将控件的容器元素添加到地图上，通过此方法可获得地图容器
事件
事件 参数 描述
resize {type, target, size} 地图可视区域大小发生变化时会触发此事件
movestart {type, target} 地图移动开始时触发此事件
moving {type, target} 地图移动过程中触发此事件
moveend {type, target} 地图移动结束时触发此事件
zoomstart {type, target} 地图更改缩放级别开始时触发触发此事件
zoomend {type, target} 地图更改缩放级别结束时触发触发此事件
addoverlay {type, target, overlay} 当使用Map.addOverlay()方法向地图中添加单个覆盖物时会触发此事件
removeoverlay {type, target, overlay} 当使用Map.removeOverlay()方法移除单个覆盖物时会触发此事件
clearoverlays {type, target} 当使用Map.clearOverlays()方法一次性移除全部覆盖物时会触发此事件
addmassfeatures {type, target, massFeatures} 当使用Map.addMassFeatures()方法向地图中添加海量覆盖物时会触发此事件
removemassfeatures {type, target, massFeatures} 当使用Map.removeMassFeatures()方法移除海量覆盖物时会触发此事件
clearmassfeatures {type, target} 当使用Map.clearMassFeatures()方法一次性移除全部海量覆盖物时会触发此事件
massfeaturesclick {type, massFeatures} 当点击添加到地图的MassFeature时候会触发此事件，其中massFeatures是被点击的MassFeature的集合
addcontrol {type, target, control} 当使用Map.addControl()方法向地图中添加单个控件时会触发此事件
removecontrol {type, target, control} 当使用Map.removeControl()方法移除单个控件时会触发此事件
addtilelayer {type, target, tilelayer} 添加一个自定义地图图层时触发此事件
removetilelayer {type, target, tilelayer} 移除一个自定义地图图层时触发此事件
touchstart {type, target, point,pixel} 触摸开始时触发此事件，仅适用移动设备
touchmove {type, target, point,pixel} 触摸移动时触发此事件，仅适用移动设备
touchend {type, target, point,pixel} 触摸结束时触发此事件，仅适用移动设备
gesturestart {type, target, point,pixel} 手势开始事件
gesturechange {type, target, point,pixel} 手势过程中事件
gestureend {type, target, point,pixel} 手势结束事件
MapOptions
此类表示Map构造函数的可选参数。通过对象字面量形式表示。
属性
属性 类型 描述
minZoom Number 地图允许展示的最小级别，默认为3
maxZoom Number 地图允许展示的最大级别，默认为18
enableDragging Boolean 是否开启底图拖拽功能，默认true，开启
enableDblclickZoom Boolean 是否开启双击放大功能，默认true，开启
enablePinchToZoom Boolean 是否开启双指缩放地图，默认true，开启
enableInertialDragging Boolean 是否开启地图惯性拖拽，默认true，开启
mapStyle MapStyle 个性化底图配置
Viewport
Map类方法的setViewport与getViewport参数。通过对象字面量形式表示。
属性
属性 类型 描述
center Point 地图视野中心点
zoom Number 地图级别
ViewportOptions
此类作为map.getViewport与map.setViewport方法的可选参数，不可实例化。
属性
属性 类型 描述
enableAnimation Boolean 是否启用动画效果移动地图，默认为true。当调整后的级别与当前地图级别一致时，将使用动画效果移动地图
margins Array<Number&bt; 视野调整的预留边距，例如： margins: [30, 20, 0, 20] 表示坐标点会限制在上述区域内
PanOptions
Map类方法panTo与panBy的可选参数。通过对象字面量形式表示。
属性
属性 类型 描述
noAnimation Boolean 不使用动画效果, 默认false(使用动画效果)
MapStyle
此类表示个性化底图配置的参数对象
属性
属性 类型 描述
style String 个性化模板
styleJson Object 个性化Json样式

基础类

Bounds
此类表示地理坐标的矩形区域。
构造函数
构造函数 描述
Bounds(sw: Point, ne: Point) 创建一个包含所有给定点坐标的矩形区域。其中sw表示矩形区域的西南角，参数ne表示矩形区域的东北角
方法
方法 返回值 描述
equals(other: Bounds) Boolean 当且仅当此矩形中的两点参数都等于其他矩形的两点参数时，返回true
extend(point: Point) none 放大此矩形，使其包含给定的点
getCenter() Point 返回矩形的中心点
isEmpty() Boolean 如果矩形为空，则返回true
getSouthWest() Point 返回矩形区域的西南角
getNorthEast() Point 返回矩形区域的东北角
toSpan() Point 返回矩形区域的跨度
Pixel
此类表示地图上的一点，单位为像素。
构造函数
构造函数 描述
Pixel(x: Number, y: Number) 创建像素点对象实例。像素坐标的坐标原点为地图区域的左上角
属性
属性 类型 描述
x Number x坐标
y Number y坐标
方法
方法 返回值 描述
equals(other: Pixel) Boolean 判断坐标点是否相等，当且仅当两点的x坐标和y坐标均相等时返回true
Point
此类表示一个地理坐标点。
构造函数
构造函数 描述
Point(lng: Number, lat: Number) 以指定的x坐标和y坐标创建一个地理点坐标，兼容性问题，字段仍使用lng,lat
属性
属性 类型 描述
lng Number x坐标
lat Number y坐标
方法
方法 返回值 描述
equals(other: Point) Boolean 判断坐标点是否相等，当且仅当两点的x值和y值均相等时返回true
Size
此类以像素表示一个矩形区域的大小。
构造函数
构造函数 描述
Size(width: Number, height: Number) 以指定的宽度和高度创建一个矩形区域大小对象
属性
属性 类型 描述
width Number 水平方向的数值
height Number 竖直方向的数值
方法
方法 返回值 描述
equals(other: Size) Boolean 当且仅当此矩形中的宽度和高度都等于其他矩形的宽度和高度时，返回true

控件类

Control
此类是所有控件的基类，您可以通过此类来实现自定义控件。所有控件均包含Control类的属性、方法和事件。通过Map.addControl()方法可将控件添加到地图上。
构造函数
构造函数 描述
Control() 创建一个控件原型实例，通过继承该原型实例，可创建自定义控件
方法
方法 返回值 描述
initialize(map: Map) HTMLElement 抽象方法。调用Map.addControl()方法添加控件时将调用此方法，从而实现该控件的初始化。自定义控件时需要实现此方法，并将元素的DOM元素在该方法中返回。DOM元素需要添加到地图的容器中，使用map.getContainer()方法可获得地图容器元素
setAnchor(anchor: ControlAnchor) none 设置控件停靠的位置
getAnchor() ControlAnchor 返回控件停靠的位置
setOffset(offset: Size) none 设置控件停靠的偏移量
getOffset() Size 返回控件停靠的偏移量
show() none 显示控件
hide() none 隐藏控件
isVisible() Boolean 判断控件的可见性
remove() none 从地图中移除控件. 该方法在地图主类的removeControl方法中调用
ControlAnchor
此常量表示控件的定位。
常量
常量 描述
BMAP_ANCHOR_TOP_LEFT 控件将定位到地图的左上角
BMAP_ANCHOR_TOP_RIGHT 控件将定位到地图的右上角
BMAP_ANCHOR_BOTTOM_LEFT 控件将定位到地图的左下角
BMAP_ANCHOR_BOTTOM_RIGHT 控件将定位到地图的右下角
ScaleControl
此类表示比例尺控件，此类继承Control所有接口。
构造函数
构造函数 描述
ScaleControl(opts: ScaleControlOptions) 创建一个比例尺控件
方法
方法 返回值 描述
initialize() HTMLElement Map主类addControl方法中将会调用此方法，完成HTML生成、事件绑定
setColor() none 设置比例尺颜色
getColor() String 获取比例尺颜色
ScaleControlOptions
此类表示ScaleControl构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
anchor ControlAnchor 控件的停靠位置
color String 比例尺的显示颜色
ZoomControl
此类表示缩放控件，此类继承Control所有接口。
构造函数
构造函数 描述
ZoomControl(opts: ZoomControlOptions) 创建一个缩放控件
方法
方法 返回值 描述
initialize() HTMLElement Map主类addControl方法中将会调用此方法，完成HTML生成、事件绑定
ZoomControlOptions
此类表示ZoomControlOptions构造函数的可选参数。通过对象字面量形式表示。
属性
属性 类型 描述
anchor ControlAnchor 控件的停靠位置，默认定位到地图的右下角

覆盖物类

Overlay
覆盖物的抽象基类，所有覆盖物均继承基类的方法。
方法
方法 返回值 描述
initialize(map: Map) HTMLElement 抽象方法，用于初始化覆盖物，当调用map.addOverlay时，API将调用此方法。自定义覆盖物时需要实现此方法。自定义覆盖物时需要将覆盖物对应的HTML元素返回
isVisible() Boolean 判断覆盖物是否可见
draw() none 抽象方法，当地图状态发生变化时，由系统调用对覆盖物进行绘制。自定义覆盖物需要实现此方法
show() none 显示覆盖物。对于自定义覆盖物，此方法会自动将initialize方法返回的HTML元素样式的display属性设置为空
hide() none 隐藏覆盖物。对于自定义覆盖物，此方法会自动将initialize方法返回的HTML元素样式的display属性设置为none
remove() none 删除覆盖物，Map.removeOverlay时将调用此方法
Marker
此类表示地图上一个图像标注，此类继承Overlay的所有接口。
构造函数
构造函数 描述
Marker(point: Point, opts: MarkerOptions) 创建一个图像标注实例。point参数指定了图像标注所在的地理位置
方法
方法 返回值 描述
setIcon(icon: Icon) none 设置标注所用的图标对象
getIcon() Icon 返回标注所用的图标对象
setPosition(position: Point) none 设置标注的地理坐标
getPosition() Point 返回标注的地理坐标
setOffset(offset: Size) none 设置标注的偏移值
getOffset() Size 返回标注的偏移值
setTop(isTop: Boolean) none 将标注置于其他标注之上。默认情况下，纬度较低的标注会覆盖在纬度较高的标注之上，从而形成一种立体效果。通过此方法可使某个标注覆盖在其他所有标注之上。注意：如果在多个标注对象上调用此方法，则这些标注依旧按照纬度产生默认的覆盖效果
事件
事件 参数 描述
click {type, target, pixel, point} Marker被点击时触发，参数可获取到点击时Marker的屏幕坐标pixel及地理坐标point
MarkerOptions
此类表示Marker构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
offset Size 标注的位置偏移值
icon Icon 标注所用的图标对象
enableMassClear Boolean 是否在调用map.clearOverlays清除此覆盖物，默认为true
clickable Boolean 是否响应点击事件。默认为true
baseZIndex Number 基准zIndex
isTop Boolean 将标注置于其他标注之上，默认为false，纬度低盖住纬度高的标注
Icon
此类表示标注覆盖物所使用的图标。图标涉及到的anchor，size，imageOffset，backGroundImageSize等属性，为了使用方便，只需根据原始图片值设置原始高宽、偏移值即可，系统会自动除以2做高清效果
构造函数
构造函数 描述
Icon(url: String, size: Size, opts: IconOptions) 以给定的图像地址和大小创建图标对象实例
属性
属性 类型 描述
anchor Size 图标的定位点相对于图标左上角的偏移值
size Size 图标大小
imageOffset Size 图标所用的图片相对于可视区域的偏移值，此功能的作用等同于CSS中的background-position属性。
backGroundImageSize Size 图标所用的图片的大小，此功能的作用等同于CSS中的background-size属性。
imageUrl String 图标所用图像资源的位置
方法
方法 返回值 描述
setImageUrl(imageUrl: String) none 设置图片资源的地址
setSize(size: Size) none 设置图标大小
setAnchor(anchor: Size) none 设置图标定位点相对于其左上角的偏移值
setImageOffset(offset: Size) none 设置图标使用的图片相对于可视区域的偏移值
getHTML() String 获取icon的html代码
setBackGroundImageSize() none 设置背景图的大小
toString() Icon 返回类型信息
IconOptions
此类表示Icon构造函数的可选参数。通过对象字面量形式表示。
属性
属性 类型 描述
anchor Size 图标的定位锚点。此点用来决定图标与地理位置的关系，是相对于图标左上角的偏移值，默认等于图标宽度和高度的中间值
imageOffset Size 图标所用的图片相对于可视区域的偏移值
backGroundImageSize Size 背景图片大小
MassFeature
此类表示地图上一个海量覆盖物标注。 此类的数组集合可通过Map主类的addMassFeatures，removeMassFeatures，clearMassFeatures在地图中操作。通过监听Map主类的massfeaturesclick事件可获取到被点击到的MassFeature集合
构造函数
构造函数 描述
MassFeature(point: Point, opts: MassFeatureOptions) 创建一个图像标注实例。point参数指定了标注所在的地理位置
方法
方法 返回值 描述
getIcon() Icon 返回标注所用的图标对象
getPosition() Point 返回标注的地理坐标
getData() String 获取用户存储的数据
MassFeatureOptions
此类表示MassFeature构造函数的可选参数。通过对象字面量形式表示。
属性
属性 类型 描述
data String 标注的用户数据
icon Icon 标注所用的图标对象
margin Number 扩大点击区域，更容易的能点击到添加的海量覆盖物。默认为0，不扩大点击范围

地图图层类

TileLayer
此类表示一个地图图层，您可以向地图中添加自定义图层。
构造函数
构造函数 描述
TileLayer(opts: TileLayerOptions) 创建一个地图图层实例
方法
方法 返回值 描述
getTilesUrl(tileCoord: Pixel, zoom: Number) String 抽象方法。返回Map主类图块的x,y,z值，图块索引由tileCoord的x和y属性及缩放级别zoom提供。
initialize() none 地图图层初始化, 创建图层容器
remove() none 移除图层
TileLayerOptions
此类表示TileLayer构造函数的可选参数
属性
属性 类型 描述
baseLayer Boolean 是否是基础图层，默认为false
zIndex Number 图层的zIndex，默认为0