核心类

Map
此类是地图API的核心类，用来实例化一个地图。请注意WebGL版本的地图API的命名空间是BMapGL。
示例：const map = new BMapGL.Map('container');
构造函数
构造函数 描述
Map(container: String | HTMLElement, opts: MapOptions ) 在指定的容器内创建地图实例，之后需要调用Map.centerAndZoom()方法对地图进行初始化。未进行初始化的地图将不能进行任何操作
方法
方法 返回值 描述
enableDragging() none 启用地图拖拽，默认启用
disableDragging() none 禁用地图拖拽
enableInertialDragging() none 启用地图惯性拖拽，默认禁用
disableInertialDragging() none 禁用地图惯性拖拽
enableScrollWheelZoom() none 允许地图可被鼠标滚轮缩放，默认禁用
disableScrollWheelZoom() none 禁止地图被鼠标滚轮缩放
enableContinuousZoom() none 开启双击平滑缩放效果
disableContinuousZoom() none 关闭双击平滑缩放效果
enableResizeOnCenter() none 开启图区resize中心点不变
disableResizeOnCenter() none 关闭图区resize中心点不变
enableDoubleClickZoom() none 启用地图双击缩放，左键双击放大、右键双击缩小
disableDoubleClickZoom() none 取消地图双击缩放
enableKeyboard() none 启用键盘操作，默认禁用。键盘的上、下、左、右键可连续移动地图。同时按下其中两个键可使地图进行对角移动。PgUp、PgDn、Home和End键会使地图平移其1/2的大小。+、-键会使地图放大或缩小一级
disableKeyboard() none 禁用键盘操作
enablePinchToZoom() none 启用双指缩放地图。
disablePinchToZoom() none 禁用双指缩放地图。
enableRotateGestures() none 是否允许通过手势旋转地图。
enableTiltGestures() none 是否允许通过手势倾斜地图。
enableAutoResize() none 启用自动适应容器尺寸变化，默认启用
disableAutoResize() none 禁用自动适应容器尺寸变化
checkResize() none 地图容器变化后调用此方法用来重新铺图
resize() none 强制地图调整尺寸，此时会以当前容器尺寸为基准重新计算视野所需图像数据并重新绘制。当关闭自动调整视野时（`enableAutoResize` 配置），需要调用此方法来强制地图刷新。
getSize() Size 返回地图当前尺寸，以像素表示
getContainerSize() Size 获取地图容器尺寸
getZoomUnits() Number 返回当前地图级别，一个像素对应多少单位的平面墨卡托坐标
getContainer() HTMLElement 返回地图的DOM容器元素。当创建用户自定义控件时，需要自行实现Control.initialize()方法，并将控件的容器元素添加到地图上，通过此方法可获得地图容器
pixelToPoint(pixel: Pixel ) Point 像素坐标转换为经纬度坐标
pointToPixel(point: Point ) Pixel 经纬度坐标转换为像素坐标
lnglatToMercator(lng: Number, lat: Number) [McLng, McLat] 经纬度球体坐标转换为墨卡托平面坐标
mercatorToLnglat(McLng: Number, lat: McLat) [lng, lat] 墨卡托平面坐标转换为经纬度球体坐标
isLoaded() boolean 返回地图是否经过centerAndZoom进行初始化
addSpots(spots: Array, options: Object) number 添加地点区域，作为地图上的虚拟可点击区域。其中参数spots为热区点数组，options为可选配置参数；返回区域id。
getSpots(id: string) Array 根据id返回地点区域数组
removeSpots(id: number) none 根据id移除区域数组
clearSpots() none 清除地点区域，此操作将清空所有虚拟可点数据
clearLabels() none 清空当前map所有的自定义底图标注
addLabelsToMapTile(labels:Array) none 在底图上添加文字，这些文字会和底图文字一同参与避让。
removeLabelsFromMapTile(labelUids:Array) none 从底图上移除文字标注，参数为uid数组，根据数组里的uid进行移除
getIconByClickPosition(clickPosition: Pixel) Object | null 通过点击坐标获取当前点中的底图icon，如果获取到返回其{name, uid, position}，否则返回null
setBounds(bounds:Bounds) none 设置地图可拖动区域，参数为地图拖拽的区域范围
getBounds() Bounds 获取地图当前视野范围的矩形区域，以地理坐标表示。如果地图尚未初始化则返回一个空的 `Bounds` 实例。
getCoordType() string 获取地图坐标类型，为CoordType常量
getMapStyleId() string 获取当前地图样式id，对于内置样式则返回样式名称；对于自定义样式，则返回内部自动生成的样式id
getPanes() MapPanes 获取覆盖物容器元素，返回地图覆盖物容器对象
getInfoWindow() InfoWindow | null 获取当前打开的信息窗口实例，如果当前地图没有处于打开状态信息窗口，则返回 `null`
setDefaultCursor(cursor: String) none 设置地图默认的鼠标指针样式。参数cursor应符合CSS的cursor属性规范
getDefaultCursor() String 获取地图默认的鼠标指针样式，返回cursor值
setDraggingCursor(cursor: String) none 设置拖拽地图时的鼠标指针样式。参数cursor应符合CSS的cursor属性规范
getDraggingCursor() String 返回拖拽地图时的鼠标指针样式
setMinZoom(zoom: Number) none 设置地图允许的最小级别。取值不得小于地图类型所允许的最小级别
setMaxZoom(zoom: Number) none 设置地图允许的最大级别。取值不得大于地图类型所允许的最大级别
getDistance(start: Point , end: Point ) Number 返回两点之间的距离，单位是米
getMapType() MapTypeId 返回地图类型
setViewport(view: Array<Point> | Viewport , viewportOptions: ViewportOptions ) none 根据提供的地理区域或坐标设置地图视野，调整后的视野会保证包含提供的地理区域或坐标
getViewport(view: Array< Point >, viewportOptions: ViewportOptions ) Viewport 根据提供的地理区域或坐标获得最佳的地图视野，返回的对象中包含center和zoom属性，分别表示地图的中心点和级别。此方法仅返回视野信息，不会将新的中心点和级别做用到当前地图上
centerAndZoom(center: Point , zoom: Number) none 设初始化地图。 如果center类型为Point时，zoom必须赋值，范围3-19级，若调用高清底图（针对移动端开发）时，zoom可赋值范围为3-18级。如果center类型为字符串时，比如“北京”，zoom可以忽略，地图将自动根据center适配最佳zoom级别
panTo(center: Point ) none 将地图的中心点更改为给定的点，跳转到指定中心点进行渲染。如果该点在当前的地图视图中已经可见，则会以平滑动画的方式移动到中心点位置。可以通过配置强制移动过程不使用动画效果
panBy(x: Number, y: Number) none 将地图在水平位置上移动x像素，垂直位置上移动y像素。如果指定的像素大于可视区域范围或者在配置中指定没有动画效果，则不执行滑动效果
flyTo(center: Point , zoom: Number) none 飞到指定的中心点和级别，提供给定位缩放地图使用
reset() none 重新设置地图，恢复地图初始化时的中心点和级别
setCenter(center: Point | String[, options: Object]) none 设置地图中心点。center除了可以为坐标点以外，还支持城市名。可选配置参数包括'noAnimation: boolean'是否禁用动画效果；'callback: function'动画结束后调用此方法，如果没有动画则立即调用
getCenter() Point 返回地图当前中心点
setMapType(mapTypeId: MapTypeId ) none 设置地图类型
setZoom(zoom: Number[,options]) none 将视图切换到指定的缩放等级，中心点坐标不变。注意：当有信息窗口在地图上打开时，地图缩放将保证信息窗口所在的坐标位置不动。可选配置参数包括'noAnimation：boolean'是否禁用动画效果；'callback:function'动画结束后会调用此方法，如果没有动画则立即调用；'zoomCenter：Point'缩放中心点，默认以地图中心点为基准缩放
getZoom() Number 返回地图当前缩放级别
zoomIn() none 放大一级视图
zoomOut() none 缩小一级视图
addControl(control: Control ) none 将控件添加到地图，一个控件实例只能向地图中添加一次
removeControl(control: Control ) none 从地图中移除控件。如果控件从未被添加到地图中，则该移除不起任何作用
addContextMenu()(menu: ContextMenu ) none 添加右键菜单
removeContextMenu()(menu: ContextMenu ) none 移除右键菜单
addOverlay(overlay: Overlay ) none 将覆盖物添加到地图中，一个覆盖物实例只能向地图中添加一次
removeOverlay(overlay: Overlay ) none 从地图中移除覆盖物。如果覆盖物从未被添加到地图中，则该移除不起任何作用
clearOverlays() none 清除地图上所有覆盖物
pointToOverlayPixel(point: Point ) Pixel 根据地理坐标获取对应的覆盖物容器的坐标，此方法用于自定义覆盖物
overlayPixelToPoint(pixel: Pixel ) Point 根据覆盖物容器的坐标获取对应的地理坐标
getOverlays() Array< Overlay > 获取当前地图上的所有覆盖物，返回覆盖物对象的集合
getPanes() MapPanes 返回地图覆盖物容器列表
getCurrentMaxTilt() number 获取当前地图允许的最大倾斜角度
hightlightSpotByUid(uid: string, tilePosStr: string) none 根据 uid 将底图上的 poi 高亮显示，其中参数tilePosStr为label的位置字符串
resetSpotStatus() none 重置热区状态，即将高亮的热区点取消
addAreaSpot() none 重置热区状态，即将高亮的热区点取消
getAreaSpot(id: string) Array 返回地点区域数组
removeAreaSpot(id: string) none 移除区域数组
clearAreaSpots() none 清除地点区域，此操作将清空所有虚拟可点数据
setTrafficOn() none 开启路况图层
setTrafficOff() none 关闭路况图层
showOverlayContainer() none 显示覆盖物
hideOverlayContainer() none 不显示覆盖物
setMapStyleV2(config: Object) none 设置个性化地图，参数为个性化配置对象
startViewAnimation(viewAnimation: ViewAnimation) Number 启动视角动画
cancelViewAnimation(viewAnimation: ViewAnimation) none 停止视角动画
getMapScreenshot() url 获取地图截图，地球模式不支持。需要初始化地图配置preserveDrawingBuffer：true，否则是黑屏
loadMapStyleFiles(callback: Function) none 加载地图当前样式所需要的样式文件，callback为加载成功后的回调函数
setCopyrightOffset(logo: Object, cpy: Object) none 设置版权信息位置，其中logo为logo位置，copyright为文字位置
destroy() none 销毁地图，当使用 WebGL 渲染地图时，如果确认不再使用该地图实例，则需要调用本方法销毁 WebGL 上下文，否则频繁创建新地图实例会导致浏览器报：too many WebGL context 的警告
isSupportEarth() boolean 判断浏览器是否支持地球,支持返回true,否则返回false
事件
事件 参数 描述
click {type, target, latlng, pixel, overlay} 左键单击地图时触发此事件。 当双击时，产生的事件序列为： click click dblclick
dblclick {type, target, pixel, point} 鼠标双击地图时会触发此事件
rightclick {type, target, latlng, pixel, overlay} 右键单击地图时触发此事件。 当双击时，产生的事件序列为： rightclick rightclick rightdblclick
rightdblclick {type, target, latlng, pixel, overlay} 右键双击地图时触发此事件
maptypechange {type, target} 地图类型发生变化时触发此事件
mousemove {type, target, latlng, pixel, overlay} 鼠标在地图区域移动过程中触发此事件
mouseover {type, target} 鼠标移入地图区域时触发此事件
mouseout {type, target} 鼠标移出地图区域时触发此事件
movestart {type, target} 地图移动开始时触发此事件
moving {type, target} 地图移动过程中触发此事件
moveend {type, target} 地图移动结束时触发此事件
zoomstart {type, target} 地图更改缩放级别开始时触发触发此事件
zoomend {type, target} 地图更改缩放级别结束时触发触发此事件
addoverlay {type, target} 当使用Map.addOverlay()方法向地图中添加单个覆盖物时会触发此事件
addcontrol {type, target} 当使用Map.addControl()方法向地图中添加单个控件时会触发此事件
removecontrol {type, target} 当使用Map.removeControl()方法移除单个控件时会触发此事件
removeoverlay {type, target} 当使用Map.removeOverlay()方法移除单个覆盖物时会触发此事件
clearoverlays {type, target} 当使用Map.clearOverlays()方法一次性移除全部覆盖物时会触发此事件
dragstart {type, target, pixel, point} 开始拖拽地图时触发
dragging {type, target, pixel, point} 拖拽地图过程中触发
dragend {type, target, pixel, point} 停止拖拽地图时触发
resize {type, target, size} 地图可视区域大小发生变化时会触发此事件
MapOptions
此类表示Map构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
minZoom Number 地图允许展示的最小级别
maxZoom Number 地图允许展示的最大级别
mapType MapTypeId 地图类型，默认为BMAP_NORMAL_MAP
enableAutoResize Boolean 开启自动适应地图容器变化，默认启用
Viewport
此类代表视野，不可实例化，通过对象字面量形式表示。
属性
属性 类型 描述
center Point 视野中心点
zoom Number 视野级别
ViewportOptions
此类作为map.getViewport与map.setViewport方法的可选参数，不可实例化。
属性
属性 类型 描述
enableAnimation Boolean 是否启用动画效果移动地图，默认为true。当调整后的级别与当前地图级别一致时，将使用动画效果移动地图
margins Array<Number> 视野调整的预留边距，例如： margins: [30, 20, 0, 20] 表示坐标点会限制在上述区域内
zoomFactor Number 地图级别的偏移量，您可以在方法得出的结果上增加一个偏移值。例如map.setViewport计算出地图的级别为10，如果zoomFactor为-1，则最终的地图级别为9
delay Number 改变地图视野的延迟执行时间，单位毫秒，默认为200ms。此延时仅针对动画效果有效

基础类

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

控件类

Control
此类是所有控件的基类，您可以通过此类来实现自定义控件。所有控件均包含Control类的属性、方法和事件。通过Map.addControl()方法可将控件添加到地图上。
构造函数
构造函数 描述
Control() 创建一个控件原型实例，通过该原型实例可创建自定义控件
属性
属性 类型 描述
defaultAnchor ControlAnchor 控件默认的停靠位置。自定义控件时需要提供此属性，作为控件的默认停靠位置
defaultOffset Size 控件默认的位置偏移值。自定义控件时需要提供此属性，作为控件的默认偏移位置
方法
方法 返回值 描述
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 判断控件的可见性
ControlAnchor
此常量表示控件的定位。
常量
常量 描述
BMAP_ANCHOR_TOP_LEFT 控件将定位到地图的左上角
BMAP_ANCHOR_TOP_RIGHT 控件将定位到地图的右上角
BMAP_ANCHOR_BOTTOM_LEFT 控件将定位到地图的左下角
BMAP_ANCHOR_BOTTOM_RIGHT 控件将定位到地图的右下角
NavigationControl3D
此类表示地图的3D控件，可以对地图进行旋转以及切换地图2D、3D展示效果。
构造函数
构造函数 描述
NavigationControl3D(opts: NavigationControl3DOptions ) 创建一个特定样式的地图平移缩放控件
NavigationControl3DOptions
此类表示NavigationControl3D构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
anchor ControlAnchor 控件的停靠位置
offset Size 控件的偏移值
ScaleControl
此类表示比例尺控件。
构造函数
构造函数 描述
ScaleControl(opts: ScaleControlOptions ) 创建一个比例尺控件
方法
方法 返回值 描述
getUnit() LengthUnit 返回比例尺单位制
setUnit(unit: LengthUnit ) none 设置比例尺单位制
ScaleControlOptions
此类表示ScaleControl构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
anchor ControlAnchor 控件的停靠位置
offset Size 控件的偏移值
LengthUnit
常量表示长度单位制。
常量
常量 描述
BMAP_UNIT_METRIC 公制单位
BMAP_UNIT_IMPERIAL 英制单位
ZoomControl
此类表示缩放控件。
构造函数
构造函数 描述
ZoomControl(opts: ZoomControlOptions ) 创建一个缩放控件
ZoomControlOptions
此类表示ZoomControl构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
anchor ControlAnchor 控件的停靠位置
offset Size 控件的偏移值

覆盖物类

Overlay
覆盖物的抽象基类，所有覆盖物均继承基类的方法。此类不可实例化。
方法
方法 返回值 描述
initialize(map: Map ) HTMLElement 抽象方法，用于初始化覆盖物，当调用map.addOverlay时，API将调用此方法。自定义覆盖物时需要实现此方法。自定义覆盖物时需要将覆盖物对应的HTML元素返回
isVisible() Boolean 判断覆盖物是否可见
draw() none 抽象方法，当地图状态发生变化时，由系统调用对覆盖物进行绘制。自定义覆盖物需要实现此方法
show() none 显示覆盖物。对于自定义覆盖物，此方法会自动将initialize方法返回的HTML元素样式的display属性设置为空
hide() none 隐藏覆盖物。对于自定义覆盖物，此方法会自动将initialize方法返回的HTML元素样式的display属性设置为none
MapPanes
此类表示地图上所有覆盖物的容器集合，没有构造函数，通过对象字面量形式表示。通过Map的getPanes方法可获得该对象实例。
属性
属性 类型 描述
floatPane HTMLElement 信息窗口所在的容器
markerMouseTarget HTMLElement 标注点击区域所在的容器
floatShadow HTMLElement 信息窗口阴影所在的容器
labelPane HTMLElement 文本标注所在的容器
markerPane HTMLElement 标注图标所在的容器
Marker
此类表示地图上的一个图像标注。
构造函数
构造函数 描述
Marker(point: Point , opts: MarkerOptions ) 创建一个图像标注实例。point参数指定了图像标注所在的地理位置
方法
方法 返回值 描述
setIcon(icon: Icon ) none 设置标注所用的图标对象
getIcon() Icon 返回标注所用的图标对象
setPosition(position: Point ) none 设置标注的地理坐标
getPosition() Point 返回标注的地理坐标
setOffset(offset: Size ) none 设置标注的偏移值
getOffset() Size 返回标注的偏移值
setTitle(title: String) none 设置标注的标题，当鼠标移至标注上时显示此标题
getTitle() String 返回标注的标题
setLabel(label: Label ) none 为标注添加文本标注
getLabel() Label 返回标注的文本内容
enableDragging() none 开启标注拖拽功能
disableDragging() none 关闭标注拖拽功能
enableMassClear() none 允许覆盖物在map.clearOverlays方法中被清除
disableMassClear() none 禁止覆盖物在map.clearOverlays方法中被清除
setZIndex(zIndex: Number) none 设置覆盖物的zIndex
getMap() Map 返回覆盖物所在的map对象
setRotation(rotation: Number) none 设置点的旋转角度
getRotation() Number 获取点的旋转角度
addEventListener(event: String, handler: Function) none 添加事件监听函数
removeEventListener(event: String, handler: Function) none 移除事件监听函数
MarkerOptions
此类表示Marker构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
offset Size 标注的位置偏移值
icon Icon 标注所用的图标对象
enableMassClear Boolean 是否在调用map.clearOverlays清除此覆盖物，默认为true
enableDragging Boolean 是否启用拖拽，默认为false
enableClicking Boolean 是否响应点击事件。默认为true
raiseOnDrag Boolean 拖拽标注时，标注是否开启离开地图表面效果。默认为false
draggingCursor String 拖拽标注时的鼠标指针样式。此属性值需遵循CSS的cursor属性规范
rotation Number 旋转角度
title String 鼠标移到marker上的显示内容
Icon
此类表示标注覆盖物所使用的图标。
构造函数
构造函数 描述
Icon(url: String, size: Size , opts: IconOptions ) 以给定的图像地址和大小创建图标对象实例
属性
属性 类型 描述
anchor Size 图标的定位点相对于图标左上角的偏移值
size Size 图标可视区域的大小
imageOffset Size 图标所用的图片相对于可视区域的偏移值，此功能的作用等同于CSS中的background-position属性
imageSize Size 图标所用的图片的大小，此功能的作用等同于CSS中的background-size属性。可用于实现高清屏的高清效果
imageUrl String 图标所用图像资源的位置
printImageUrl String 设置icon打印图片的url，该打印图片只针对IE6有效，解决IE6使用PNG滤镜导致的错位问题。如果您的icon没有使用PNG格式图片或者没有使用CSS Sprites技术，则可忽略此配置
方法
方法 返回值 描述
setImageUrl(imageUrl: String) none 设置图片资源的地址
setSize(size: Size ) none 设置图标可视区域的大小
setImageSize(offset: Size ) none 设置图标的大小
setAnchor(anchor: Size ) none 设置图标定位点相对于其左上角的偏移值
setImageOffset(offset: Size ) none 设置图片相对于可视区域的偏移值
IconOptions
此类表示Icon构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
anchor Size 图标的定位锚点。此点用来决定图标与地理位置的关系，是相对于图标左上角的偏移值，默认等于图标宽度和高度的中间值
imageOffset Size 图片相对于可视区域的偏移值
InfoWindow
此类表示地图上包含信息的窗口。
构造函数
构造函数 描述
InfoWindow(content: String | HTMLElement, opts: InfoWindowOptions ) 创建一个信息窗实例，其中content支持HTML内容。
方法
方法 返回值 描述
setWidth(width: Number) none 设置信息窗口的宽度，单位像素。取值范围：220 - 730
setHeight(height: Number) none 设置信息窗口的高度，单位像素。取值范围：60 - 650
redraw() none 重绘信息窗口，当信息窗口内容发生变化时进行调用
setTitle(title: String | HTMLElement) none 设置信息窗口标题。支持HTML内容。1.2版本开始title参数支持传入DOM结点
getTitle() String | HTMLElement 返回信息窗口标题
setContent(content: String | HTMLElement) none 设置信息窗口内容。支持HTML内容。1.2版本开始content参数支持传入DOM结点
getContent() String | HTMLElement 返回信息窗口内容
getPosition() Point 返回信息窗口的位置
enableMaximize() none 启用窗口最大化功能。需要设置最大化后信息窗口里的内容，该接口才生效
disableMaximize() none 禁用窗口最大化功能
isOpen() Boolean 返回信息窗口的打开状态
setMaxContent(content: String) none 信息窗口最大化时所显示内容，支持HTML内容
maximize() none 最大化信息窗口
restore() none 还原信息窗口
enableAutoPan() none 开启打开信息窗口时地图自动平移
disableAutoPan() none 关闭打开信息窗口时地图自动平移
enableCloseOnClick() none 开启点击地图时关闭信息窗口
disableCloseOnClick() none 关闭点击地图时关闭信息窗口
addEventListener(event: String, handler: Function) none 添加事件监听函数
removeEventListener(event: String, handler: Function) none 移除事件监听函数
事件
事件 参数 描述
close event{type, target, point} 信息窗口被关闭时触发此事件
open event{type, target, point} 信息窗口被打开时触发此事件
maximize event{type, target} 信息窗口最大化后触发此事件
restore event{type, target} 信息窗口还原时触发此事件
clickclose event{type, target} 点击信息窗口的关闭按钮时触发此事件
InfoWindowOptions
此类表示InfoWindow构造函数的可选参数，它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
width Number 信息窗宽度，单位像素。取值范围：0, 220 - 730。如果您指定宽度为0，则信息窗口的宽度将按照其内容自动调整
height Number 信息窗高度，单位像素。取值范围：0, 60 - 650。如果您指定高度为0，则信息窗口的高度将按照其内容自动调整
maxWidth Number 信息窗最大化时的宽度，单位像素。取值范围：220 - 730
offset Size 信息窗位置偏移值。默认情况下在地图上打开的信息窗底端的尖角将指向其地理坐标，在标注上打开的信息窗底端尖角的位置取决于标注所用图标的infoWindowOffset属性值，您可以为信息窗添加偏移量来改变默认位置
title String 信息窗标题文字，支持HTML内容
enableAutoPan Boolean 是否开启信息窗口打开时地图自动移动（默认开启）
enableCloseOnClick Boolean 是否开启点击地图关闭信息窗口（默认开启）
Label
此类表示地图上的文本标注。
构造函数
构造函数 描述
Label(content: String, opts: LabelOptions ) 创建一个文本标注实例。point参数指定了文本标注所在的地理位置
方法
方法 返回值 描述
setStyle(styles: Object) none 设置文本标注样式，该样式将作用于文本标注的容器元素上。其中styles为JavaScript对象常量，比如： setStyle({ color : "red", fontSize : "12px" }) 注意：如果css的属性名中包含连字符，需要将连字符去掉并将其后的字母进行大写处理，例如：背景色属性要写成：backgroundColor
setContent(content: String) none 设置文本标注的内容。支持HTML
setPosition(position: Point) none 设置文本标注坐标。仅当通过Map.addOverlay()方法添加的文本标注有效
getPosition() Point 获取Label的地理坐标
setOffset(offset: Size) none 设置文本标注的偏移值
getOffset() Size 返回文本标注的偏移值
setTitle(title: String) none 设置文本标注的标题，当鼠标移至标注上时显示此标题
getTitle() String 返回文本标注的标题
enableMassClear() none 允许覆盖物在map.clearOverlays方法中被清除
disableMassClear() none 禁止覆盖物在map.clearOverlays方法中被清除
setZIndex(zIndex: Number) none 设置覆盖物的zIndex
setPosition(position: Point) none 设置地理坐标
getMap() Map 返回覆盖物所在的map对象
addEventListener(event: String, handler: Function) none 添加事件监听函数
removeEventListener(event: String, handler: Function) none 移除事件监听函数
事件
事件 参数 描述
click event{type, target} 点击文本标注后会触发此事件
dblclick event{type, target} 双击文本标注后会触发此事件
mousedown event{type, target} 鼠标在文本标注上按下触发此事件
mouseup event{type, target} 鼠标在文本标注释放触发此事件
mouseout event{type, target} 鼠标离开文本标注时触发此事件
mouseover event{type, target} 当鼠标进入文本标注区域时会触发此事件
remove event{type, target} 移除文本标注时触发
rightclick event{type, target} 右键点击标注时触发此事件
LabelOptions
此类表示Lable构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
offset Size 文本标注的位置偏移值
position Point 文本标注的地理位置
enableMassClear Boolean 是否在调用map.clearOverlays清除此覆盖物，默认为true
Polyline
使用浏览器的矢量制图工具（如果可用）在地图上绘制折线的地图叠加层。
构造函数
构造函数 描述
Polyline(points: Array< Point >, opts: PolylineOptions ) 创建折线覆盖物对象
方法
方法 返回值 描述
setPath(path: Array< Point >) none 设置折线的点数组
getPath() Array< Point > 返回折线的点数组
setStrokeColor(color: String) none 设置折线的颜色
getStrokeColor() String 返回折线的颜色
setStrokeOpacity(opacity: Number) none 设置透明度，取值范围0 - 1
getStrokeOpacity() Number 返回透明度
setStrokeWeight(weight: Number) none 设置线的宽度，范围为大于等于1的整数
getStrokeWeight() Number 返回线的宽度
setStrokeStyle(style: String) none 设置是为实线或虚线，solid或dashed
getStrokeStyle() String 返回当前线样式状态，实线或者虚线
getBounds() Bounds 返回覆盖物的地理区域范围
enableEditing() none 开启编辑功能
disableEditing() none 关闭编辑功能
enableMassClear() none 允许覆盖物在map.clearOverlays方法中被清除
disableMassClear() none 禁止覆盖物在map.clearOverlays方法中被清除
setPositionAt(index: Number, point: Point ) none 修改指定位置的坐标。索引index从0开始计数。例如setPointAt(2, point)代表将折线的第3个点的坐标设为point
getMap() Map 返回覆盖物所在的map对象
addEventListener(event: String, handler: Function) none 添加事件监听函数
removeEventListener(event: String, handler: Function) none 移除事件监听函数
PolylineOptions
此类表示Polyline构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
strokeColor String 折线颜色
strokeWeight Number 折线的宽度，以像素为单位
strokeOpacity Number 折线的透明度，取值范围0 - 1
strokeStyle String 折线的样式，solid或dashed
enableMassClear Boolean 是否在调用map.clearOverlays清除此覆盖物，默认为true
enableEditing Boolean 是否启用线编辑，默认为false
enableClicking Boolean 是否响应点击事件，默认为true
geodesic Boolean 是否开启大地线模式，true时，两点连线将以大地线的形式。默认为false
clip Boolean 是否进行跨经度180度裁剪，绘制跨精度180时为了优化效果，可以设置成false，默认为true
Polygon
此类表示一个多边形覆盖物。
构造函数
构造函数 描述
Polygon(points: Array< Point >, opts: PolygonOptions ) 创建多边形覆盖物
方法
方法 返回值 描述
setPath(path: Array< Point >) none 设置多边型的点数组
getPath() Array< Point > 返回多边型的点数组
setStrokeColor(color: String) none 设置多边型的边线颜色，参数为合法的CSS颜色值
getStrokeColor() String 返回多边型的边线颜色
setFillColor(color: String) none 设置多边形的填充颜色，参数为合法的CSS颜色值。当参数为空字符串时，折线覆盖物将没有填充效果
getFillColor() String 返回多边形的填充颜色
setStrokeOpacity(opacity: Number) none 设置多边形的边线透明度，取值范围0 - 1
getStrokeOpacity() Number 返回多边形的边线透明度
setFillOpacity(opacity: Number) none 设置多边形的填充透明度，取值范围0 - 1
getFillOpacity() Number 返回多边形的填充透明度
setStrokeWeight(weight: Number) none 设置多边形边线的宽度，取值为大于等于1的整数
getStrokeWeight() Number 返回多边形边线的宽度
setStrokeStyle(style: String) none 设置多边形边线样式为实线或虚线，取值solid或dashed
getStrokeStyle() String 返回多边形边线样式
getBounds() Bounds 返回覆盖物的地理区域范围
enableEditing() none 开启编辑功能
disableEditing() none 关闭编辑功能
enableMassClear() none 允许覆盖物在map.clearOverlays方法中被清除
disableMassClear() none 禁止覆盖物在map.clearOverlays方法中被清除
setPositionAt(index: Number, point: Point ) none 修改指定位置的坐标。索引index从0开始计数。例如setPositionAt(2, point)代表将折线的第3个点的坐标设为point
getMap() Map 返回覆盖物所在的map对象
addEventListener(event: String, handler: Function) none 添加事件监听函数
removeEventListener(event: String, handler: Function) none 移除事件监听函数
PolygonOptions
此类表示Polygon构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
strokeColor String 边线颜色
fillColor String 填充颜色。当参数为空时，折线覆盖物将没有填充效果
strokeWeight Number 边线的宽度，以像素为单位
strokeOpacity Number 边线透明度，取值范围0 - 1
fillOpacity Number 填充的透明度，取值范围0 - 1
strokeStyle String 边线的样式，solid或dashed
enableMassClear Boolean 是否在调用map.clearOverlays清除此覆盖物，默认为true
enableEditing Boolean 是否启用线编辑，默认为false
enableClicking Boolean 是否响应点击事件，默认为true
Circle
此类表示地图上的圆覆盖物。
构造函数
构造函数 描述
Circle(center: Point , radius: Number, opts: CircleOptions ) 创建圆覆盖物
方法
方法 返回值 描述
setCenter(center: Point ) none 设置圆形的中心点坐标
getCenter() Point 返回圆形的中心点坐标
setRadius(radius: Number) none 设置圆形的半径，单位为米
getRadius() Number 返回圆形的半径，单位为米
getBounds() Bounds 返回圆形的地理区域范围
setStrokeColor(color: String) none 设置圆形的边线颜色，参数为合法的CSS颜色值
getStrokeColor() String 返回圆形的边线颜色
setFillColor(color: String) none 设置圆形的填充颜色，参数为合法的CSS颜色值。当参数为空字符串时，圆形覆盖物将没有填充效果
getFillColor() String 返回圆形的填充颜色
setStrokeOpacity(opacity: Number) none 设置圆形的边线透明度，取值范围0 - 1
getStrokeOpacity() Number 返回圆形的边线透明度
setFillOpacity(opacity: Number) none 设置圆形的填充透明度，取值范围0 - 1
getFillOpacity() Number 返回圆形的填充透明度
setStrokeWeight(weight: Number) none 设置圆形边线的宽度，取值为大于等于1的整数
getStrokeWeight() Number 返回圆形边线的宽度
setStrokeStyle(style: String) none 设置圆形边线样式为实线或虚线，取值solid或dashed
getStrokeStyle() String 返回圆形边线样式
enableEditing() none 开启编辑功能
disableEditing() none 关闭编辑功能
enableMassClear() none 允许覆盖物在map.clearOverlays方法中被清除
disableMassClear() none 禁止覆盖物在map.clearOverlays方法中被清除
getMap() Map 返回覆盖物所在的map对象
addEventListener(event: String, handler: Function) none 添加事件监听函数
removeEventListener(event: String, handler: Function) none 移除事件监听函数
CircleOptions
Circle类构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
strokeColor String 圆形边线颜色
fillColor String 圆形填充颜色。当参数为空时，圆形将没有填充效果
strokeWeight Number 圆形边线的宽度，以像素为单位
strokeOpacity Number 圆形边线透明度，取值范围0 - 1
fillOpacity Number 圆形填充的透明度，取值范围0 - 1
strokeStyle String 圆形边线的样式，solid或dashed
enableMassClear Boolean 是否在调用map.clearOverlays清除此覆盖物，默认为true
enableEditing Boolean 是否启用线编辑，默认为false
enableClicking Boolean 是否响应点击事件，默认为true
GroundOverlay
此类表示地图上的地面叠加层。
构造函数
构造函数 描述
GroundOverlay(bounds: Bounds , opts: GroundOverlayOptions ) 创建地面叠加层
方法
方法 返回值 描述
setBounds(bounds: Bounds) none 设置图层显示的矩形区域
getBounds() Bounds 返回图层显示的矩形区域
setOpacity(opcity: Number) none 设置图层的透明度
getOpacity() Number 返回图层的透明度
setImageURL(url: String) none 返回图层地址
getImageURL() String 返回图层地址
setDisplayOnMinLevel(level: Number) none 设置图层显示的最小级别
getDisplayOnMinLevel() Number 返回图层显示的最小级别
setDispalyOnMaxLevel(level: Number) none 设置图层显示的最大级别
getDispalyOnMaxLevel() Number 返回图层显示的最大级别
事件
事件 参数 描述
click event{type, target} 鼠标点击图层后会触发此事件
dblclick event{type, target} 鼠标双击图层后会触发此事件
GroundOverlayOptions
GroundOverlay类构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
opacity Number 图层透明度
imageURL String 图层地址
displayOnMinLevel Number 图层显示的最小级别
displayOnMaxLevel Number 图层显示的最大级别
BezierCurve
此类表示一个二阶贝塞尔曲线覆盖物
构造函数
构造函数 描述
BezierCurve(points: Array< Point >, controlPoints: Array< Point >, opts: BezierCurveOptions ) 创建二阶贝塞尔曲线覆盖物，构造函数中必须定义坐标点和曲线的控制点
方法
方法 返回值 描述
setPath(path: Array< Point >) none 设置曲线的路径点
getPath() Array< Point > 返回曲线的路径点
setControlPoints(path: Array< Point >) none 设置曲线的控制点，每两个路径点之间可以有1或2个控制点，比如路径点有三个点，那个控制点的格式可以是：[ [cp1, cp2], [ cp3 ] ]，其中cp1和cp2为路经点1到2的控制点，cp3为路径点2到3的控制点
getControlPoints() Array< Point > 返回曲线的控制点
setStrokeColor(color: String) none 设置曲线的颜色
getStrokeColor() String 返回曲线的颜色
setStrokeOpacity(opacity: Number) none 设置透明度，取值范围0 - 1
getStrokeOpacity() Number 返回透明度
setStrokeWeight(weight: Number) none 设置线的宽度，范围为大于等于1的整数
getStrokeWeight() Number 返回线的宽度
setStrokeStyle(style: String) none 设置是为实线或虚线，solid或dashed
getStrokeStyle() String 返回当前线样式状态，实线或者虚线
getBounds() Bounds 返回覆盖物的地理区域范围
enableMassClear() none 允许覆盖物在map.clearOverlays方法中被清除
disableMassClear() none 禁止覆盖物在map.clearOverlays方法中被清除
getMap() Map 返回覆盖物所在的map对象
addEventListener(event: String, handler: Function) none 添加事件监听函数
removeEventListener(event: String, handler: Function) none 移除事件监听函数
BezierCurveOptions
此类表示BezierCurve构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
strokeColor String 折线颜色
strokeWeight Number 折线的宽度，以像素为单位
strokeOpacity Number 折线的透明度，取值范围0 - 1
strokeStyle String 折线的样式，solid或dashed
enableMassClear Boolean 是否在调用map.clearOverlays清除此覆盖物，默认为true
Prism
此类表示一个棱柱覆盖物
构造函数
构造函数 描述
Prism(points: Array< Point >, altitude: Number, opts: PrismOptions ) 创建棱柱覆盖物，构造函数中需要定义底面和高度
方法
方法 返回值 描述
setPath(path: Array< Point >) none 设置底面多边形的点数组
getPath() Array< Point > 返回底面多边形的点数组
setAltitude(altitude: Number) none 设置棱柱的高，单位：米
getAltitude() Number 返回棱柱的高，单位：米
setTopFillColor(color: String) none 设置棱柱顶面的填充颜色
getTopFillColor() String 返回棱柱顶面的填充颜色
setTopFillOpacity(opacity: Number) none 设置棱柱顶面透明度，取值范围0 - 1
getTopFillOpacity() Number 返回棱柱顶面透明度
setSideFillColor(color: String) none 设置棱柱侧面的填充颜色
getSideFillColor() String 返回棱柱侧面的填充颜色
setSideFillOpacity(opacity: Number) none 设置棱柱侧面透明度，取值范围0 - 1
getSideFillOpacity() Number 返回棱柱侧面透明度
enableMassClear() none 允许覆盖物在map.clearOverlays方法中被清除
disableMassClear() none 禁止覆盖物在map.clearOverlays方法中被清除
getMap() Map 返回覆盖物所在的map对象
addEventListener(event: String, handler: Function) none 添加事件监听函数
removeEventListener(event: String, handler: Function) none 移除事件监听函数
PrismOptions
此类表示PrismOptions构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
topFillColor String 顶面填充颜色
topFillOpacity Number 顶面填充颜色透明度，取值范围0 - 1
sideFillColor String 侧面填充颜色
sideFillOpacity Number 侧面填充颜色透明度，取值范围0 - 1
enableMassClear Boolean 是否在调用map.clearOverlays清除此覆盖物，默认为true

右键菜单类

ContextMenu
此类表示右键菜单。您可以在地图上添加自定义内容的右键菜单。
构造函数
构造函数 描述
ContextMenu() 创建一个右键菜单实例
方法
方法 返回值 描述
addItem(item: MenuItem) none 添加菜单项
getItem(index: Number) MenuItem 返回指定索引位置的菜单项，第一个菜单项的索引为0
removeItem(item: MenuItem) none 移除菜单项
addSeparator() none 添加分隔符
removeSeparator(index: Number) none 移除指定索引位置的分隔符，第一个分隔符的索引为0
事件
事件 参数 描述
open event{type, target, point, pixel} 右键菜单打开时触发，事件参数point和pixel分别表示菜单开启时的地理和像素坐标点
close event{type, target, point, pixel} 右键菜单关闭时触发，事件参数point和pixel分别表示菜单开启时的地理和像素坐标点
MenuItem
此类表示一个菜单项。
构造函数
构造函数 描述
MenuItem(text: String, callback: Function, opts: MenuItemOptions) 创建一个菜单项。当菜单项被点击时，系统将会以当前菜单弹出的地理坐标点作为参数调用回调函数callback
方法
方法 返回值 描述
setText(text: String) none 设置菜单项显示的文本
enable() none 启用菜单项
disable() none 禁用菜单项
MenuItemOptions
此类表示MenuItem构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
width Number 指定此菜单项的宽度，菜单以最长的菜单项宽度为准
id String 指定此菜单项dom的id

地图类型类

MapTypeId
地图类型常量
常量
常量 描述
BMAP_NORMAL_MAP 此地图类型展示普通街道视图
BMAP_EARTH_MAP 此地图类型展示地球卫星视图

地图图层类

TileLayer
此类表示一个地图图层，您可以向地图中添加自定义图层。
构造函数
构造函数 描述
TileLayer(opts: TileLayerOptions) 创建一个地图图层实例
方法
方法 返回值 描述
getTilesUrl(tileCoord: Pixel, zoom: Number) String 抽象。向地图返回地图图块的网址，图块索引由tileCoord的x和y属性在指定的缩放级别zoom提供。如果您在TileLayerOptions中提供了tileUrlTemplate参数，则可不实现此接口
isTransparentPng() Number 如果图层所用的图片为PNG格式并且包含透明信息，则返回true
TileLayerOptions
此类表示TileLayer构造函数的可选参数
属性
属性 类型 描述
transparentPng Boolean 是否使用了带有透明信息的PNG。由于IE6不支持PNG透明，因此需要特殊处理
tileUrlTemplate String 指定图块网址模板，该模板可以针对每个图块请求而展开，以根据现有的图块坐标系引用唯一的图块。模板的格式应该为：http://yourhost/tile?x={X}&y={Y}&z={Z}.png 其中X和Y分别指纬度和经度图块坐标，Z指缩放级别，比如： http://yourhost/tile?x=3&y=27&z=5.png 如果您没有提供图块网址模板，您需要实现TileLayer.getTileUrl()抽象方法
zIndex Number 图层的zIndex

视角动画类

ViewAnimation
地图视角动画类。
构造函数
构造函数 描述
ViewAnimation(keyFrames: Array<ViewAnimationKeyFrames>, opts: ViewAnimationOptions) 创建地图视角动画对象，通过关键帧的形式对动画进行定义
事件
事件 参数 描述
animationstart {} 动画开始时触发，如果配置了delay，则在delay后触发
animationiterations {} 当动画循环大于1次时，上一次结束既下一次开始时触发。最后一次循环结束时不触发
animationend {} 动画结束时触发，如果动画中途被终止，则不会触发
animationcancel {} 动画中途被终止时触发
ViewAnimationKeyFrames
此类表示地图视角动画的关键帧，通过定义关键帧，API会补全关键帧之间过渡的动画过程。
属性
属性 类型 描述
center Point 地图中心点，默认值为地图当前状态中心点
zoom Number 地图缩放级别，默认值为地图当前状态缩放级别
tilt Number 地图倾斜角度，默认值为地图当前状态倾斜角度
heading Number 地图旋转角度，默认值为地图当前旋转角度
percentage Number 表示当前关键帧处于动画过程的百分比，取值范围0~1
ViewAnimationOptions
此类表示地图视角动画的配置。
属性
属性 类型 描述
delay Number 动画开始延迟时间，单位ms，默认0
duration Number 动画持续时间，单位ms，默认1000
interation Number | string 循环次数，参数类型为数字时循环固定次数，参数为'INFINITE'无限循环，默认为1

服务类

LocalSearch
用于位置检索、周边检索和范围检索。
构造函数
构造函数 描述
LocalSearch(location: Map | Point | String, opts: LocalSearchOptions ) 创建一个搜索类实例，其中location表示检索区域，其类型可为地图实例、坐标点或城市名称的字符串。当参数为地图实例时，检索位置由当前地图中心点确定，且搜索结果的标注将自动加载到地图上，并支持调整地图视野层级；当参数为坐标时，检索位置由该点所在位置确定；当参数为城市名称时，检索会在该城市内进行
方法
方法 返回值 描述
search(keyword: String | Array<String>, option: Object) none 根据检索词发起检索。当keyword为数组时将同时执行多关键字的查询，最多支持10个关键字，多关键字自 1.2 版本支持。option:{forceLocal:Boolean, customData:CustomData} forceLocal表示是否将搜索范围约束在当前城市，customData表示检索lbs云服务的数据
searchInBounds(keyword: String | Array<String>, bounds: Bounds , option: Object) none 根据范围和检索词发起范围检索。当keyword为数组时将同时执行多关键字检索，最多支持10个关键字，多关键字自 1.2 版本支持。option:{customData:CustomData} customData表示检索lbs云服务的数据
searchNearby(keyword: String | Array<String>, center: LocalResultPoi | String | Point , radius: Number, option: Object) none 根据中心点、半径与检索词发起周边检索。当keyword为数组时将同时执行多关键字的检索，最多支持10个关键字，多关键字自 1.2 版本支持。当center为字符串时，半径参数将忽略。注意：Point类型的中心点自 1.1 版本支持。option:{customData:CustomData} customData表示检索lbs云服务的数据
getResults() LocalResult | Array<LocalResult> 返回最近一次检索的结果。如果是多关键字范围检索，则返回一个LocalResult的数组，数组中的结果顺序和范围检索中多关键字数组中顺序一致
clearResults() none 清除最近一次检索的结果
gotoPage(page: Number) none 检索特定页面的结果
enableAutoViewport() none 启用根据结果自动调整地图层级，当指定了搜索结果所展现的地图时有效
disableAutoViewport() none 禁用根据结果自动调整地图层级
enableFirstResultSelection() none 启用自动选择第一个检索结果
disableFirstResultSelection() none 禁用自动选择第一个检索结果
setLocation(location: Map | Point | String) none 设置检索范围，参数类型可以为地图实例、坐标点或字符串。例：setLocation("北京市")
setPageCapacity() none 设置每页容量，取值范围：1 - 100，对于多关键字检索，每页容量表示每个关键字返回结果的数量（例如当用2个关键字检索时，实际结果数量范围为：2 - 200）。此值只对下一次检索有效
getPageCapacity() Number 返回每页容量，对于多关键字检索，返回每个关键字对应的页面容量
setSearchCompleteCallback() none 设置检索结束后的回调函数。参数：results: LocalResult 或 Array 如果是多关键字检索，回调函数参数为LocalResult的数组，数组中的结果顺序和检索中多关键字数组中顺序一致
setMarkersSetCallback(callback: Function) none 设置添加标注后的回调函数。参数： pois: Array ，通过marker属性可得到其对应的标注
setInfoHtmlSetCallback(callback: Function) none 设置标注气泡创建时的回调函数。参数： poi: LocalResultPoi，通过其marker属性可得到当前的标注。 html: HTMLElement，气泡内的Dom元素
setResultsHtmlSetCallback(callback: Function) none 设置结果列表创建后的回调函数。参数： container: HTMLElement，结果列表所用的HTML元素
getStatus() StatusCodes 返回状态码
LocalSearchOptions
此类表示LocalSearch构造函数的可选参数。
属性
属性 类型 描述
renderOptions LocalRenderOptions 结果呈现设置
onMarkersSet Function 标注添加完成后的回调函数。 参数： pois: Array ，通过marker属性可得到其对应的标注
onInfoHtmlSet Function 标注气泡内容创建后的回调函数。 参数： poi: LocalResultPoi，通过其marker属性可得到当前的标注。 html: HTMLElement，气泡内的Dom元素
onResultsHtmlSet Function 结果列表添加完成后的回调函数。 参数： container: HTMLElement，结果列表所用的HTML元素
pageCapacity Number 设置每页容量，取值范围：1 - 100，对于多关键字检索，容量表示每个关键字的数量，如果有2个关键字，则实际检索结果数量范围为：2 - 200
onSearchComplete Function 检索完成后的回调函数。 参数：results: LocalResult或Array 如果是多关键字检索，回调函数参数返回一个LocalResult的数组，数组中的结果顺序和检索中多关键字数组中顺序一致
CustomData
此类表示检索lbs云服务的数据。它没有构造函数，但可通过对象字面量形式表示。 要检索lbs云服务的数据，需要在引用api的时候在参数后加上lbs云平台的key。
属性
属性 类型 描述
geotableId Number lbs云v2接口，可在lbs云平台上查看自己的geotableId
tags String 空格分隔的多字符串
filter String 过滤条件，参考：lbsyun.baidu.com/index.php?title=lbscloud/api/geosearch
RenderOptions
此类表示搜索结果呈现的配置。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
map Map 展现结果的地图实例。当指定此参数后，搜索结果的标注、线路等均会自动添加到此地图上
panel String | HTMLElement 结果列表的HTML容器id或容器元素，提供此参数后，结果列表将在此容器中进行展示。此属性对LocalCity无效。驾车路线规划无效
selectFirstResult Boolean 是否选择第一个检索结果。此属性仅对LocalSearch有效
autoViewport Boolean 检索结束后是否自动调整地图视野。此属性对LocalCity无效
LocalResult
类表示LocalSearch的检索结果，没有构造函数，通过LocalSearch.getResults()方法或LocalSearch的onSearchComplete回调函数的参数得到。
属性
属性 类型 描述
keyword String 本次检索的关键词
center LocalResultPoi 周边检索的中心点（仅当周边检索时提供）
radius Number 周边检索的半径（仅当周边检索时提供）
bounds Bounds 范围检索的地理区域（仅当范围检索时提供）
city String 本次检索所在的城市
moreResultsUrl String 更多结果的链接，到百度地图进行搜索
province String 本次检索所在的省份
suggestions Array<String> 搜索建议列表。（当关键词是拼音或拼写错误时给出的搜索建议）
方法
方法 返回值 描述
getPoi(i: Number) LocalResultPoi 返回索引指定的结果。索引0表示第1条结果
getCurrentNumPois() Number 返回当前页的结果数
getNumPois() Number 返回总结果数
getNumPages() Number 返回总页数
getPageIndex() Number 返回页数序号
getCityList() Array<Object> 返回城市列表。数组元素对象包含如下属性： city: String，城市名 numResults: Number，结果数
LocalResultPoi
此类表示位置检索或路线规划的一个结果点，没有构造函数，可通过对象字面量形式表示。
属性
属性 类型 描述
title String 结果的名称标题
point Point 该结果所在的地理位置
url String 在百度地图中展示该结果点的详情信息链接
address String 地址（根据数据部分提供）。注：当结果点类型为公交站或地铁站时，地址信息为经过该站点的所有车次
city String 所在城市
phoneNumber String 电话，根据数据部分提供
postcode String 邮政编码，根据数据部分提供
type PoiType 类型，根据数据部分提供
isAccurate Boolean 是否精确匹配。只适用LocalSearch的search方法检索的结果
province String 所在省份
tags Array<String> POI的标签，如商务大厦、餐馆等。目前只有LocalSearch的回调函数onSearchComplete(result)中的result和Geocoder.getLocation的回调函数的参数GeocoderResult.surroundingPois涉及的LocalResultPoi有tags字段。其他API涉及的LocalResultPoi没有该字段
detailUrl String 在百度地图详情页面展示该结果点的链接。localsearch的结果中才有
PoiType
此枚举常量表示地点的类型。
常量
常量 描述
BMAP_POI_TYPE_NORMAL 一般位置点
BMAP_POI_TYPE_BUSSTOP 公交车站位置点
BMAP_POI_TYPE_SUBSTOP 地铁车站位置点
TransitRoute
用于获取公交线路规划方案。
构造函数
构造函数 描述
TransitRoute(location: Map | Point | String, opts: TransitRouteOptions ) 创建一个公交导航实例。location表示检索区域，类型可为地图实例、坐标点或城市名称的字符串。当参数为地图实例时，检索位置由当前地图中心点确定；当参数为坐标时，检索位置由该点所在位置确定；当参数为城市名称时，检索会优先在该城市内进行
方法
方法 返回值 描述
search(start: Point | LocalResultPoi, end: Point | LocalResultPoi) none 发起检索。 start: 起点，参数可以坐标点或者LocalSearchPoi实例。 end: 终点，参数可以是坐标点或者LocalSearchPoi实例，3.0版本暂不支持起终点参数为关键字，开发者可以先用检索接口确认关键字的坐标点
getResults() TransitRouteResult 返回最近一次检索的结果
clearResults() none 清除最近一次检索的结果
enableAutoViewport() none 启用自动调整地图层级，当指定了搜索结果所展现的地图时有效
disableAutoViewport() none 禁用自动调整地图层级
setPageCapacity(capacity: Number) 设置每页返回方案个数（1-5），默认为5
setPolicy(policy: TransitPolicy ) none 设置城市内换乘策略
setIntercityPolicy(intercityPolicy: IntercityPolicy ) none 设置跨城换乘策略
setTransitTypePolicy(transitTypePolicy: TransitTypePolicy ) none 设置跨城交通方式策略
setSearchCompleteCallback(callback: Function) none 设置检索结束后的回调函数。 参数： results: TransitRouteResult，公交导航结果
setMarkersSetCallback(callback: Function) none 设置添加标注后的回调函数。 参数： pois: Array ，起点和目的地数组。 transfers: Array ，公交车站数组
setInfoHtmlSetCallback(callback: Function) none 设置气泡打开后的回调函数。 参数： poi: LocalResultPoi，表示当前气泡对应的点（可以是起点、终点或换乘车站） html: HTMLElement，气泡内的DOM元素
setPolylinesSetCallback(callback: Function) none 设置添加路线后的回调函数。 参数： lines: Array ，公交线路数组。 routes: Array ，步行线路数组，通过Route.getPolyline()方法可得到对应的折线覆盖物
setResultsHtmlSetCallback(callback: Function) none 设置结果列表创建后的回调函数。 参数： container: 结果列表所用的HTML元素
getStatus() StatusCodes 返回状态码
toString() String 返回线路规划对象类型
TransitRouteOptions
此类表示TransitRoute构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性
属性 类型 描述
renderOptions RenderOptions 搜索结果的呈现设置
policy TransitPolicy 市内公交的策略参数
intercityPolicy IntercityPolicy 跨城公交的换乘策略参数
transitTypePolicy TransitTypePolicy 跨城公交的交通方式策略参数
pageCapacity Number 返回方案的个数
onSearchComplete Function 检索完成后的回调函数。参数：results: TransitRouteResult，公交导航结果
onMarkersSet Function 标注添加完成后的回调函数。参数：pois: Array ，起点和目的地数组。transfers: Array ，公交车站数组
onInfoHtmlSet Function 气泡内容创建后的回调函数。参数：poi: LocalResultPoi，表示当前气泡对应的点（可以是起点、终点或换乘车站）html: HTMLElement，气泡内的DOM元素
onPolylinesSet Function 折线添加完成后的回调函数。参数：lines: Array ，公交线路数组。routes: Array ，步行线路数组，通过Route.getPolyline()方法可得到对应的折线覆盖物
onResultsHtmlSet Function 结果列表添加完成后的回调函数。参数：container: 结果列表所用的HTML元素
TransitPolicy
此常量表示市内公交方案换乘策略。
常量
常量 描述
BMAP_TRANSIT_POLICY_RECOMMEND 推荐方案
BMAP_TRANSIT_POLICY_LEAST_TIME 最少时间
BMAP_TRANSIT_POLICY_LEAST_TRANSFER 最少换乘
BMAP_TRANSIT_POLICY_LEAST_WALKING 最少步行
BMAP_TRANSIT_POLICY_AVOID_SUBWAYS 不乘地铁
BMAP_TRANSIT_POLICY_FIRST_SUBWAYS 优先地铁
IntercityPolicy
此常量表示跨城公交换乘策略。
常量
常量 描述
BMAP_INTERCITY_POLICY_LEAST_TIME 时间短
BMAP_INTERCITY_POLICY_EARLY_START 出发早
BMAP_INTERCITY_POLICY_CHEAP_PRICE 价格低
TransitTypePolicy
此常量表示跨城交通方式策略。
常量
常量 描述
BMAP_TRANSIT_TYPE_POLICY_TRAIN 火车优先
BMAP_TRANSIT_TYPE_POLICY_AIRPLANE 飞机优先
BMAP_TRANSIT_TYPE_POLICY_COACH 大巴优先
TransitRouteResult
此类表示路线导航的结果，没有构造函数，通过访问TransitRoute.getResults()方法或TransitRoute的onSearchComplete回调函数参数获得。
属性
属性 类型 描述
policy TransitPolicy 公交导航策略
intercityPolicy IntercityPolicy 跨城策略（仅跨城时有）
transitTypePolicy TransitTypePolicy 跨城交通方式策略（仅跨城时有）
方法
方法 返回值 描述
getStart()() LocalResultPoi 返回起点
getEnd()() LocalResultPoi 返回终点
getNumPlans()() Number 返回方案个数
getPlan(i: Number)(i: Number) TransitRoutePlan 返回索引指定的方案。索引0表示第一条方案
getTransitType()() TransitType 返回公交出行方案的类型
TransitRoutePlan
此类表示一条公交出行方案。没有构造函数，通过TransitRouteResult.getPlan()方法获得。
方法
方法 返回值 描述
getNumLines() Number 返回方案包含的公交线路段数(如果是跨城检索，还包括飞机、火车、大巴线路)
getLine(i: Number) Line 返回方案包含的某条公交线路(如果是跨城检索，还包括飞机、火车、大巴线路)
getNumRoutes() Number 返回方案包含的步行线路段数
getRoute(i: Number)
getDistance(format: Boolean) String | Number 返回方案总距离。当format参数为true时，返回方案距离字符串（包含单位），当format为false时，仅返回数值（单位为米）信息。默认参数为true
getDuration(format: Boolean) String | Number 返回方案总时间。当format参数为true时，返回描述时间的字符串（包含单位），当format为false时，仅返回数值（单位为秒）信息。默认参数为true
getDescription(includeHtml: Boolean) String 返回方案描述文本，默认包含HTML标签。当includeHtml为false时，方案描述不包含HTML标签
getTotalType(i: Number) TransitPlanType 返回指定路段的交通方式类型，分别对应Line和Route
getTotal(i: Number) Route | Line 返回整个方案包含的某段线路，根据方案的数据情况，返回值可能是步行对象Route也有可能是线路对象Line
getNumTotal() Number 总路段数量
TransitType
此常量表示出行方案的类型
常量
常量 描述
BMAP_TRANSIT_TYPE_IN_CITY 国内市内换乘
BMAP_TRANSIT_TYPE_CROSS_CITY 国内跨城换乘
LineType
此枚举类型标识不同类型的交通线路类型，其中包括了市内公交和跨城公交。
常量
常量 描述
BMAP_LINE_TYPE_BUS 公交车
BMAP_LINE_TYPE_SUBWAY 地铁
BMAP_LINE_TYPE_FERRY 轮渡
BMAP_LINE_TYPE_TRAIN 火车
BMAP_LINE_TYPE_AIRPLANE 飞机
BMAP_LINE_TYPE_COACH 大巴
WalkingRoute
用于获取步行路线规划方案。
构造函数
构造函数 描述
WalkingRoute(location: Map | Point | String, opts: WalkingRouteOptions ) 创建一个步行导航实例。location表示检索区域，类型可为地图实例、坐标点或城市名称的字符串。当参数为地图实例时，检索位置由当前地图中心点确定；当参数为坐标时，检索位置由该点所在位置确定；当参数为城市名称时，检索会在该城市内进行
方法
方法 返回值 描述
search(start: String | Point | LocalResultPoi , end: String | Point | LocalResultPoi ) none 发起检索。 start: 起点，参数可以是关键字、坐标点（自1.1版本支持）或者LocalSearchPoi实例。 end: 终点，参数可以是关键字、坐标点（自1.1版本支持）或者LocalSearchPoi实例
getResults() WalkingRouteResult 返回最近一次检索的结果
clearResults() none 清除最近一次检索的结果
enableAutoViewport() none 启用自动调整地图层级，当指定了搜索结果所展现的地图时有效
disableAutoViewport() none 禁用自动调整地图层级
setLocation(location: Map | Point | String) none 设置检索范围，参数类型可以为地图实例、坐标点或字符串。例：setLocation("北京市")
setSearchCompleteCallback(callback: Function) none 设置检索结束后的回调函数。 参数： results: WalkingRouteResult
setMarkersSetCallback(callback: Function) none 设置添加标注后的回调函数。 参数： pois: Array ，起点和目的地点数组。通过marker属性可得到其对应的标注
setInfoHtmlSetCallback(callback: Function) none 设置气泡打开后的回调函数。 参数： poi: LocalResultPoi，通过其marker属性可得到当前的标注。 html: HTMLElement，气泡内的DOM元素
setPolylinesSetCallback(callback: Function) none 设置添加路线后的回调函数。 参数： routes: Array ，步行线路数组，通过Route.getPolyline()方法可得到对应的折线覆盖物
setResultsHtmlSetCallback(callback: Function) none 设置结果列表创建后的回调函数。 参数： container: 结果列表所用的HTML元素
getStatus() StatusCodes 返回状态码
toString() String 返回类型说明
WalkingRouteOptions
此类表示WalkingRoute构造函数的可选参数。
属性
属性 类型 描述
renderOptions RenderOptions 搜索结果呈现设置
onSearchComplete Function 检索完成后的回调函数。 参数： results: WalkingRouteResult
onMarkersSet Function 标注添加完成后的回调函数。 参数： pois: Array ，起点和目的地点数组，。通过marker属性可得到其对应的标注
onPolylinesSet Function 折线添加完成后的回调函数。 参数： routes: Array ，步行线路数组，通过Route.getPolyline()方法可得到对应的折线覆盖物
onInfoHtmlSet Function 标注气泡内容创建后的回调函数。 参数： poi: LocalResultPoi，通过其marker属性可得到当前的标注。 html: HTMLElement，气泡内的DOM元素
onResultsHtmlSet Function 结果列表添加完成后的回调函数。 参数： container: 结果列表所用的HTML元素
WalkingRouteResult
此类表示路线导航的结果，没有构造函数，通过访问WalkingRoute.getResults()方法或WalkingRoute的onSearchComplete回调函数参数获得。
方法
方法 返回值 描述
getStart() LocalResultPoi 返回起点
getEnd() LocalResultPoi 返回终点
getNumPlans() Number 返回方案个数
getPlan(i: Number) RoutePlan 返回索引指定的方案。索引0表示第一条方案
RidingRoute
用于获取骑行路线规划方案。
构造函数
构造函数 描述
RidingRoute(location: Map | Point | String, opts: RidingRouteOptions ) 创建一个骑行导航实例。location表示检索区域，类型可为地图实例、坐标点或城市名称的字符串。当参数为地图实例时，检索位置由当前地图中心点确定；当参数为坐标时，检索位置由该点所在位置确定；当参数为城市名称时，检索会在该城市内进行
方法
方法 返回值 描述
search(start: String | Point | LocalResultPoi , end: String | Point | LocalResultPoi ) none 发起检索。 start: 起点，参数可以是关键字、坐标点（自1.1版本支持）或者LocalSearchPoi实例。 end: 终点，参数可以是关键字、坐标点（自1.1版本支持）或者LocalSearchPoi实例
getResults() RidingRouteResult 返回最近一次检索的结果
clearResults() none 清除最近一次检索的结果
enableAutoViewport() none 启用自动调整地图层级，当指定了搜索结果所展现的地图时有效
disableAutoViewport() none 禁用自动调整地图层级
setLocation(location: Map | Point | String) none 设置检索范围，参数类型可以为地图实例、坐标点或字符串。例：setLocation("北京市")
setSearchCompleteCallback(callback: Function) none 设置检索结束后的回调函数。 参数： results: RidingRouteResult
setMarkersSetCallback(callback: Function) none 设置添加标注后的回调函数。 参数： pois: Array ，起点和目的地点数组。通过marker属性可得到其对应的标注
setInfoHtmlSetCallback(callback: Function) none 设置气泡打开后的回调函数。 参数： poi: LocalResultPoi，通过其marker属性可得到当前的标注。 html: HTMLElement，气泡内的DOM元素
setPolylinesSetCallback(callback: Function) none 设置添加路线后的回调函数。 参数： routes: Array ，骑行线路数组，通过Route.getPolyline()方法可得到对应的折线覆盖物
setResultsHtmlSetCallback(callback: Function) none 设置结果列表创建后的回调函数。 参数： container: 结果列表所用的HTML元素
getStatus() StatusCodes 返回状态码
toString() String 返回类型说明
RidingRouteOptions
此类表示RidingRoute构造函数的可选参数。
属性
属性 类型 描述
renderOptions RenderOptions 搜索结果呈现设置
onSearchComplete Function 检索完成后的回调函数。 参数： results: RidingRouteResult
onMarkersSet Function 标注添加完成后的回调函数。 参数： pois: Array ，起点和目的地点数组，。通过marker属性可得到其对应的标注
onPolylinesSet Function 折线添加完成后的回调函数。 参数： routes: Array ，骑行线路数组，通过Route.getPolyline()方法可得到对应的折线覆盖物
onInfoHtmlSet Function 标注气泡内容创建后的回调函数。 参数： poi: LocalResultPoi，通过其marker属性可得到当前的标注。 html: HTMLElement，气泡内的DOM元素
onResultsHtmlSet Function 结果列表添加完成后的回调函数。 参数： container: 结果列表所用的HTML元素
RidingRouteResult
此类表示骑行路线导航的结果，没有构造函数，通过访问RidingRoute.getResults()方法或RidingRoute的onSearchComplete回调函数参数获得。
方法
方法 返回值 描述
getStart()() LocalResultPoi 返回起点
getEnd()() LocalResultPoi 返回终点
getNumPlans()() Number 返回方案个数
getPlan(i: Number)(i: Number) RoutePlan 返回索引指定的方案。索引0表示第一条方案
DrivingRoute
此类用于获取驾车路线规划方案。
构造函数
构造函数 描述
DrivingRoute(location: :Map | Point | String,, opts: DrivingRouteOptions ) 创建一个驾车导航实例，其中location表示检索区域，类型可为地图实例、坐标点或城市名称的字符串。当参数为地图实例时，检索位置由地图当前的中心点确定；当参数为坐标时，检索位置由该点所在位置确定；当参数为城市名称时，检索会在该城市内进行
方法
方法 返回值 描述
search(start: Point | LocalResultPoi, end: Point | LocalResultPoi) none 发起检索。 start: 起点，参数可以是坐标点和LocalSearchPoi实例。 end: 终点，参数可以是坐标点或LocalSearchPoi实例
getResults() DrivingRouteResult 返回最近一次检索的结果
clearResults() none 清除最近一次检索的结果
enableAutoViewport() none 启用自动调整地图层级，当指定了搜索结果所展现的地图时有效
disableAutoViewport() none 禁用自动调整地图层级
setPolicy(policy: DrivingPolicy ) none 设置路线规划策略，参数为策略常量
setSearchCompleteCallback(callback: Function) none 设置检索结束后的回调函数。 参数： results: DrivingRouteResult
setMarkersSetCallback(callback: Function) none 设置添加标注后的回调函数。 参数： pois: Array，起点和目的地点数组，通过marker属性可得到其对应的标注
setInfoHtmlSetCallback(callback: Function) none 设置气泡打开后的回调函数。 参数： poi: LocalResultPoi，通过marker属性可得到当前的标注。html: HTMLElement，气泡内的DOM元素
setPolylinesSetCallback(callback: Function) none 设置添加路线后的回调函数。 参数： routes: Array ，驾车线路数组，通过Route.getPolyline()方法可得到对应的折线覆盖物
getStatus() StatusCodes 返回状态码
toString() String 返回类型说明
DrivingRouteOptions
此类表示DrivingRoute构造函数的可选参数。
属性
属性 类型 描述
renderOptions RenderOptions 结果呈现设置
policy DrivingPolicy 驾车策略
onSearchComplete Function 检索完成后的回调函数。参数： results: DrivingRouteResult
onMarkersSet Function 标注添加完成后的回调函数。 参数： pois: Array ，起点和目的地点数组，通过marker属性可得到其对应的标注
onInfoHtmlSet Function 标注气泡内容创建后的回调函数。 参数： poi: LocalResultPoi，通过marker属性可得到当前的标注。html: HTMLElement，气泡内的DOM元素
onPolylinesSet Function 折线添加完成后的回调函数。 参数： routes: Array ，驾车线路数组，通过Route.getPolyline()方法可得到对应的折线覆盖物
DrivingRouteResult
此类表示路线导航的结果，没有构造函数，通过DrivingRoute.getResults()方法或DrivingRoute的onSearchComplete回调函数参数获得。
属性
属性 类型 描述
policy DrivingPolicy 驾车导航策略
方法
方法 返回值 描述
getStart() LocalResultPoi 返回起点
getEnd() LocalResultPoi 返回终点
getNumPlans() Number 返回方案个数
getPlan(i: Number) RoutePlan 返回索引指定的方案。索引0表示第一条方案
DrivingPolicy
此枚举类型表示驾车方案的策略配置。
常量
常量 描述
BMAP_DRIVING_POLICY_DEFAULT 默认
BMAP_DRIVING_POLICY_FIRST_HIGHWAYS 优先高速
BMAP_DRIVING_POLICY_AVOID_HIGHWAYS 避开高速
BMAP_DRIVING_POLICY_AVOID_CONGESTION 避开拥堵
TaxiFare
此类表示出租车费用信息，没有构造函数，通过对象字面量形式表示。
属性
属性 类型 描述
day TaxiFareDetail 白天费用
night TaxiFareDetail 夜间费用。注意，部分城市没有夜间费用，此时此属性为null，且同时白天费用表示全天费用
distance Number 出租车里程，单位为米
remark String 出租车备注信息
TaxiFareDetail
此类表示出租车具体费用信息，没有构造函数，通过对象字面量形式表示。
属性
属性 类型 描述
initialFare Number 出租车起步价
unitFare Number 出租车单价
totalFare Number 出租车费用总价
RoutePlan
此类表示一条驾车、步行或骑行出行方案。它没有构造函数，可通过DrivingRouteResult.getPlan()方法或WalkingRouteResult类的getPlan()方法获得。
方法
方法 返回值 描述
getNumRoutes() Number 返回方案包含的线路的个数
getRoute(i: Number) Route 返回方案中索引指定的线路。索引0表示第一条线路
getDistance(format: Boolean) String | Number 返回方案总距离。当format参数为true时，返回方案距离字符串（包含单位），当format为false时，仅返回数值（单位为米）信息。默认参数为true
getDuration(format: Boolean) String | Number 返回方案总时间。当format参数为true时，返回描述时间的字符串（包含单位），当format为false时，仅返回数值（单位为秒）信息。默认参数为true
Route
此类表示一条驾车、步行或骑行路线。
方法
方法 返回值 描述
getNumSteps() Number 返回路线包含的关键点个数
getStep(i: Number) Step 返回索引指定的关键点，驾车和步行适用。索引0表示第一个关键点
getDistance(format: Boolean) String | Number 返回路线距离，当format为false时仅返回数值
getIndex() Number 返回本路线在方案中的索引位置
getPolyline() Polyline 返回路线对应的覆盖物，仅当结果自动添加到地图上时有效
getPath() Array< Point > 返回路线的地理坐标点数组
getRouteType() RouteTypes 返回路线类型，可区分是驾车还是步行线路
RouteType
常量表示不同的线路类型。
常量
常量 描述
BMAP_ROUTE_TYPE_DRIVING 驾车线路
BMAP_ROUTE_TYPE_WALKING 步行线路
BMAP_ROUTE_TYPE_RIDING 骑行线路
Step
此类表示驾车、步行或骑行路线中的一个关键点。它没有构造函数，通过Route.getStep()方法获得。
方法
方法 返回值 描述
getPosition() Point 返回关键点地理坐标
getIndex() Number 返回本关键点在路线中的位置索引
getDescription(includeHtml: Boolean) String 返回关键点描述文本，默认包含HTML标签。当includeHtml为false时，描述文本不包含HTML标签。不支持驾车路线规划
getDistance(format: Boolean) String | Number 返回到下一个关键点的距离，当format为false时仅返回数值（单位为米）
HighlightModes
此常量用于描述对象当前状态。
常量
常量 描述
BMAP_HIGHLIGHT_STEP 驾车结果展现中点击列表后的展现点步骤
BMAP_HIGHLIGHT_ROUTE 驾车结果展现中点击列表后的展现路段
Geocoder
类用于获取用户的地址解析。
构造函数
构造函数 描述
Geocoder() 创建一个地址解析器的实例
方法
方法 返回值 描述
getPoint(address: String, callback: Function, city: String) none 对指定的地址进行解析。如果地址定位成功，则以地址所在的坐标点Point为参数调用回调函数。否则，回调函数的参数为null。city为地址所在的城市名，例如“北京市”
getLocation(point: Point , callback: Function, options: LocationOptions ) none 对指定的坐标点进行反地址解析。如果解析成功，则回调函数的参数为GeocoderResult对象，否则回调函数的参数为null
GeocoderResult
此类表示Geocoder的地址解析结果。它在地址解析的回调函数的参数中返回，不可实例化。
属性
属性 类型 描述
point Point 坐标点
address String 地址描述
addressComponents AddressComponent 结构化的地址描述
surroundingPois Array< LocalResultPoi > 附近的POI点
business String 商圈字段，代表此点所属的商圈
AddressComponent
此类表示地址解析结果的层次化地址信息，没有构造函数，通过对象字面量形式表示。
属性
属性 类型 描述
streetNumber String 门牌号码
street String 街道名称
district String 区县名称
city String 城市名称
province String 省份名称
LocationOptions
此类表示Geocoder的地址解析请求的可选参数。它不可实例化。
属性
属性 类型 描述
poiRadius Number 附近POI所处于的最大半径，默认为100米
numPois Number 返回的POI点个数，默认为10个。取值范围
LocalCity
此类用于获取用户所在的城市位置信息。(根据用户IP自动定位到城市)
构造函数
构造函数 描述
LocalCity(opts: LocalCityOptions ) 创建一个获取本地城市位置的实例
方法
方法 返回值 描述
get(callback: Function) none 当获取城市信息后，回调函数会被调用，其参数为类型为LocalCityResult对象
LocalCityOptions
此类表示LocalCity的可选参数。它没有构造函数，但可通过对象字面量表示。
属性
属性 类型 描述
renderOptions RenderOptions 结果呈现设置，当给定map参数时，改地图将自动将视野定位到当前城市
LocalCityResult
此类表示LocalCity的定位结果。
属性
属性 类型 描述
center Point 城市所在中心点
level Number 展示当前城市的最佳地图级别，如果您在使用此对象时提供了map实例，则地图级别将根据您提供的地图大小进行调整
name String 城市名称
Geolocation
返回用户当前的位置，会首先调用浏览器自带的定位接口，如果失败或不支持则调用高精IP定位（需要开通权限，否则调用普通定位）接口，如果用户拒绝授权定位，则无法返回任何定位结果。
构造函数
构造函数 描述
Geolocation() 创建Geolocation对象实例
方法
方法 返回值 描述
getCurrentPosition(callback: Function, opts: PositionOptions ) none 返回用户当前位置。定位完成时（包括成功、失败、超时等情况），回调参数为GeolocationResult对象，否则为null
getStatus() StatusCode 定位完成后的状态码。分为BMAP_STATUS_SUCCESS，BMAP_STATUS_UNKNOWN_LOCATION，BMAP_STATUS_PERMISSION_DENIED，BMAP_STATUS_TIMEOUT
enableSDKLocation() none 开启SDK辅助定位，仅当使用环境为移动web混合开发，且开启了定位sdk辅助定位功能后生效
disableSDKLocation() none 关闭SDK辅助定位
GeolocationResult
此类作为Geolocation的getCurrentPosition方法的回调函数参数，不可实例化。
属性
属性 类型 描述
point Point 定位坐标点
accuracy Number 定位精度，单位为米
address AddressComponent 根据定位坐标点解析出的地址信息，可能为空（3.0新增）
PositionOptions
此类为getCurrentPosition的可选参数，不能实例化。
属性
属性 类型 描述
enableHighAccuracy Boolean 是否要求浏览器获取最佳效果，同浏览器定位接口参数。默认为false
timeout Number 超时事件，单位为毫秒。默认为10秒
maximumAge Number 允许返回指定事件内的缓存结果，单位为毫秒。如果为0，则每次请求都获取最新的定位结果。默认为10分钟
SDKLocation Boolean 是否开启SDK辅助定位
BusLineSearch
公交路线搜索类。
构造函数
构造函数 描述
BusLineSearch(location: Map | Point | String, options: BusLineSearchOptions ) 创建公交线搜索类。其中location表示检索区域，其类型可为地图实例、坐标点或城市名称的字符串。当参数为地图实例时，检索位置由当前地图中心点确定；当参数为坐标时，检索位置由该点所在位置确定；当参数为城市名称时，检索会在该城市内进行
方法
方法 返回值 描述
getBusList(keyword: String) none 在用户配置的回调函数中返回公交列表结果，其类型为BusListResult
getBusLine(busLstItem: BusListItem ) none 在用户配置的回调函数中返回该条线路的公交信息，其类型为BusLine类型
clearResults() none 清除本次公交线检索结果
enableAutoViewport() none 启用自动调整地图视野功能
disableAutoViewport() none 禁用自动调整地图视野功能
setLocation(location: Map | Point | String) none 设置检索范围，参数类型可以为地图实例、坐标点或字符串。例：setLocation("北京市")
getStatus() StatusCodes 返回状态码
toString() String 返回类型说明
setGetBusListCompleteCallback(callback: Function) none 设置公交列表查询后的回调函数。参数：rs: BusListResult类型
setGetBusLineCompleteCallback(callback: Function) none 设置公交线路查询后的回调函数。参数：rs: BusLine类型
setBusListHtmlSetCallback(callback: Function) none 公交列表结果页渲染后回调函数。参数：container: HTMLElement，结果列表所用的HTML元素
(callback: Function) none 公交线路结果页渲染后回调函数。参数：container: HTMLElement，结果列表所用的HTML元素
(callback: Function) none 添加公交线时候回调函数。参数：ply:Polyline 公交线路几何对象
(callback: Function) none 添加公交站点时候回调函数。参数：sts:Array 公交站坐标组成的Marker对象数组
BusLineSearchOptions
此类表示BusLineSearch类的可选参数，没有构造参数，可以通过对象字面量表示
属性
属性 类型 描述
renderOptions RenderOptions RenderOptions结果呈现设置
onGetBusListComplete Function 设置公交列表查询后的回调函数.参数：rs: BusListResult类型
onGetBusLineComplete Function 设置公交线路查询后的回调函数.参数：rs: BusLine类型
onBusListHtmlSet Function 公交列表结果页渲染后回调函数.参数：container: HTMLElement，结果列表所用的HTML元素
onBusLineHtmlSet Function 公交线路结果页渲染后回调函数.参数：container: HTMLElement，结果列表所用的HTML元素
onPolylinesSet Function 添加公交线时候回调函数.参数：ply:Polyline 公交线路几何对象
onMarkersSet Function 添加公交站点时候回调函数.参数：sts:Array 公交站坐标组成的Marker对象数组
BusListResult
公交列表查询成功回调函数的参数对象
属性
属性 类型 描述
keyword String 本次检索关键字
city String 本次检索所在城市
moreResultsUrl String 到百度地图查看url
方法
方法 返回值 描述
getNumBusList() Number 公交列表个数
getBusListItem(i: Number) BusListItem 获取某一个具体的公交列表中的对象。0表示上行，1表示下行
BusLine
表示公交线路结果的公交线，没有构造函数，通过检索回调函数获得。
属性
属性 类型 描述
name String 线路名称
startTime String 首班车时间
endTime String 末班车时间
company String 公交线路所属公司
方法
方法 返回值 描述
getNumBusStations() Number 获取公交站点个数
getBusStation(i: Number) BusStation 获取某一个具体的公交站对象
getPath() Array< Point > 返回公交线地理坐标点数组
getPolyline() Polyline 获取公交线几何对象, 仅当结果自动添加到地图上时有效
Line
此类表示一条公交线路，如果是跨城检索，还有可能表示一条飞机、火车或大巴线路。没有构造函数，通过TransitRoutePlan.getLine()方法得到。
属性
属性 类型 描述
title String 线路全称
type LineType 线路类型
方法
方法 返回值 描述
getNumViaStops() Number 返回公交线路途径的车站个数，仅在公交和地铁类型有效
getGetOnStop() LocalResultPoi 返回上车站
getGetOffStop() LocalResultPoi 返回下车站
getPath() Array< Point > 返回线路对应的地理坐标点数组，在公交方案中，地理坐标只给出方案涉及的部分
getPolyline() Polyline 返回公交线路对应的折线覆盖物
getDistance(format: Boolean) String | Number 当format为true时，返回本段公交线路的距离字符串（包含单位），当format为false时仅返回数值（单位为米）。默认参数为true
BusListItem
一个具体公交对象
属性
属性 类型 描述
name String 公交线名称
BusStation
公交站点对象
属性
属性 类型 描述
name String 站点名称
position Point 站点坐标
Autocomplete
Autocomplete是结果提示、自动完成类。
构造函数
构造函数 描述
Autocomplete(options: AutocompleteOptions ) 创建自动完成的实例
方法
方法 返回值 描述
show() none 显示提示列表
hide() none 隐藏提示列表
setTypes(types: type<Array>) none 修改请求数据类型。types定义方法详见AutocompleteOptions
setLocation(location: String | Map | Point ) none 设置检索区域
search(keywords: string) none 发起某个关键字的提示请求，会引起onSearchComplete的回调
getResults() AutocompleteResult 获取结果列表
setInputValue(keyword: string) none 设置绑定的input控件的值，且不会出现下拉列表
dispose() none 销毁自动完成对象
事件
事件 参数 描述
onconfirm {type,target,item} 回车选中某条记录后触发 item : { index : 1 /*高亮的记录，所属返回结果的index*/ ,value : {}/*结果数据，见AutocompleteResultPoi*/ }
onhighlight {type,target,fromitem,toitem} 键盘或者鼠标移动，某条记录高亮之后，触发 fromitem: { /*上一条记录的信息*/ index : 2 /*高亮的记录，所属返回结果的index*/ ,value : {}/*结果数据，见AutocompleteResultPoi*/ }, toitem : {/*当前记录的信息，与fromitem结构一致*/}
AutocompleteOptions
本类是Autocomplete类的可选参数对象
属性
属性 类型 描述
location String | Map | Point 设定返回结果的所属范围。例如“北京市”
types Array<String> 返回数据类型。两种设置方式，第一种为默认值（即设置值为空），将返回所有数据。如地图初始化为北京，在输入框中输入“小”，输入框下会出现包含“小”关键字的多种类型（如餐饮、地名等）的提示词条。第二种设置值为"city"，将返回省市区县乡镇街道地址类型数据。如地图初始化为北京，在输入框中输入“小”，输入框下会出现“小金县”的地点名称类的提示词条
onSearchComplete Function 在input框中输入字符后，发起列表检索，完成后的回调函数。 参数：AutocompleteResult
input String | HTMLElement 文本输入框元素或其id
AutocompleteResultPoi
自动完成类获取的单个POI点的信息
属性
属性 类型 描述
province String 省名
City String 城市名
district String 区县名称
street String 街道名称
streetNumber String 门牌号码
business String 商户名
AutocompleteResult
自动完成检索完成回调函数的参数对象
属性
属性 类型 描述
keyword String 检索关键字
方法
方法 返回值 描述
getPoi(i: Number) AutocompleteResultPoi 结果数组
getNumPois() Number 结果总数
Boundary
此类表示一个行政区域的边界。
构造函数
构造函数 描述
Boundary() 创建行政区域搜索的对象实例
方法
方法 返回值 描述
get(name: String, callback: function) null 返回行政区域的边界。 name: 查询省、直辖市、地级市、或县的名称。 callback:执行查询后，数据返回到客户端的回调函数，数据以回调函数的参数形式返回。返回结果是一个数组，数据格式如下： arr[0] = "x1, y1; x2, y2; x3, y3; ..." arr[1] = "x1, y1; x2, y2; x3, y3; ..." arr[2] = "x1, y1; x2, y2; ..." … 否则回调函数的参数为null