核心类

Map
此类是地图API的核心类,用来实例化一个地图。
构造函数
构造函数描述
Map(container: String | HTMLElement, opts: MapOptions)在指定的容器内创建地图实例,之后需要调用Map.centerAndZoom()方法对地图进行初始化。未进行初始化的地图将不能进行任何操作
方法
方法返回值描述
enableDragging()none启用地图拖拽,默认启用
disableDragging()none禁用地图拖拽
enableScrollWheelZoom()none启用滚轮放大缩小,默认禁用
disableScrollWheelZoom()none禁用滚轮放大缩小
enableDoubleClickZoom()none启用双击放大,默认启用
disableDoubleClickZoom()none禁用双击放大
enableKeyboard()none启用键盘操作,默认禁用。键盘的上、下、左、右键可连续移动地图。同时按下其中两个键可使地图进行对角移动。PgUp、PgDn、Home和End键会使地图平移其1/2的大小。+、-键会使地图放大或缩小一级
disableKeyboard()none禁用键盘操作
enableInertialDragging()none启用地图惯性拖拽,默认禁用
disableInertialDragging()none禁用地图惯性拖拽
enableContinuousZoom()none启用连续缩放效果,默认禁用
disableContinuousZoom()none禁用连续缩放效果
enablePinchToZoom()none启用双指操作缩放,默认启用
disablePinchToZoom()none禁用双指操作缩放
enableAutoResize()none启用自动适应容器尺寸变化,默认启用
disableAutoResize()none禁用自动适应容器尺寸变化
setDefaultCursor(cursor: String)none设置地图默认的鼠标指针样式。参数cursor应符合CSS的cursor属性规范
getDefaultCursor()String返回地图默认的鼠标指针样式
setDraggingCursor(cursor: String)none设置拖拽地图时的鼠标指针样式。参数cursor应符合CSS的cursor属性规范
getDraggingCursor()String返回拖拽地图时的鼠标指针样式
setMinZoom(zoom: Number)none设置地图允许的最小级别。取值不得小于地图类型所允许的最小级别
setMaxZoom(zoom: Number)none设置地图允许的最大级别。取值不得大于地图类型所允许的最大级别
setMapStyle()none设置地图样式,样式包括地图底图颜色和地图要素是否展示两部分
setPanorama(pano: Panorama)none将全景实例与Map类进行绑定
getBounds()Bounds返回地图可视区域,以地理坐标表示
getCenter()Point返回地图当前中心点
getDistance(start: Point, end: Point)Number返回两点之间的距离,单位是米
getMapType()MapType返回地图类型
getSize()Size返回地图视图的大小,以像素表示
getViewport(view: Array<Point>, viewportOptions: ViewportOptions)Viewport根据提供的地理区域或坐标获得最佳的地图视野,返回的对象中包含center和zoom属性,分别表示地图的中心点和级别。此方法仅返回视野信息,不会将新的中心点和级别做用到当前地图上
getZoom()Number返回地图当前缩放级别
getPanorama()Panorama获取与Map类绑定的全景实例
centerAndZoom(center: Point, zoom: Number)none设初始化地图。 如果center类型为Point时,zoom必须赋值,范围3-19级,若调用高清底图(针对移动端开发)时,zoom可赋值范围为3-18级。如果center类型为字符串时,比如“北京”,zoom可以忽略,地图将自动根据center适配最佳zoom级别
panTo(center: Point, opts: PanOptions)none将地图的中心点更改为给定的点。如果该点在当前的地图视图中已经可见,则会以平滑动画的方式移动到中心点位置。可以通过配置强制移动过程不使用动画效果
panBy(x: Number, y: Number, opts: PanOptions)none将地图在水平位置上移动x像素,垂直位置上移动y像素。如果指定的像素大于可视区域范围或者在配置中指定没有动画效果,则不执行滑动效果
reset()none重新设置地图,恢复地图初始化时的中心点和级别
setCenter(center: Point | String)none设置地图中心点。center除了可以为坐标点以外,还支持城市名
setCurrentCity(city: String)none设置地图城市,注意当地图初始化时的类型设置为BMAP_PERSPECTIVE_MAP时,需要在调用centerAndZoom之前调用此方法设置地图所在城市。例如: var map = new BMap.Map(“container”, {mapType: BMAP_PERSPECTIVE_MAP}); map.setCurrentCity(“北京市”); map.centerAndZoom(new BMap.Point(116.404, 39.915), 18); 注意:初始化的坐标应与您设置的城市对应,否则地图将无法正常显示。如果地图初始化为BMAP_NORMAL_MAP类型,则在调用setMapType切换地图类型时也要调用此方法
setMapType(mapType: MapTypes)none设置地图类型。注意,当设置地图类型为BMAP_PERSPECTIVE_MAP时,需要调用map.setCurrentCity方法设置城市
setViewport(view: Array<Point> | Viewport, viewportOptions: ViewportOptions)none根据提供的地理区域或坐标设置地图视野,调整后的视野会保证包含提供的地理区域或坐标
setZoom(zoom: Number)none将视图切换到指定的缩放等级,中心点坐标不变。注意:当有信息窗口在地图上打开时,地图缩放将保证信息窗口所在的坐标位置不动
highResolutionEnabled()Boolean是否使用高分辨率底图。仅当mapOptions.enableHighResolution属性为true且设备支持高分辨率时返回true
zoomIn()none放大一级视图
zoomOut()none缩小一级视图
addHotspot(hotspot: Hotspot)none为地图添加热区
removeHotspot(hotspot: Hotspot)none移除某个地图热区
clearHotspots()none清空地图所有热区
addControl(control: Control)none将控件添加到地图,一个控件实例只能向地图中添加一次
removeControl(control: Control)none从地图中移除控件。如果控件从未被添加到地图中,则该移除不起任何作用
getContainer()HTMLElement返回地图的容器元素。当创建用户自定义控件时,需要自行实现Control.initialize()方法,并将控件的容器元素添加到地图上,通过此方法可获得地图容器
addContextMenu(menu: ContextMenu)none添加右键菜单
removeContextMenu(menu: ContextMenu)none移除右键菜单
addOverlay(overlay: Overlay)none将覆盖物添加到地图中,一个覆盖物实例只能向地图中添加一次
removeOverlay(overlay: Overlay)none从地图中移除覆盖物。如果覆盖物从未被添加到地图中,则该移除不起任何作用
clearOverlays()none清除地图上所有覆盖物
openInfoWindow(infoWnd: InfoWindow, point: Point)none在地图上打开信息窗口
closeInfoWindow()none关闭在地图上打开的信息窗口。在标注上打开的信息窗口也可通过此方法进行关闭
pointToOverlayPixel(point: Point)Pixel根据地理坐标获取对应的覆盖物容器的坐标,此方法用于自定义覆盖物
overlayPixelToPoint(pixel: Pixel)Point根据覆盖物容器的坐标获取对应的地理坐标
getInfoWindow()InfoWindow | Null返回地图上处于打开状态的信息窗的实例。当地图没有打开的信息窗口时,此方法返回null
getOverlays()Array<Overlay>返回地图上的所有覆盖物
getPanes()MapPanes返回地图覆盖物容器列表
addTileLayer(tileLayer: TileLayer)none添加一个自定义地图图层
removeTileLayer(tileLayer: TileLayer)none移除一个自定义地图图层
getTileLayer(mapType: String)TileLayer通过地图类型得到一个地图图层对象
pixelToPoint(pixel: Pixel)Point像素坐标转换为经纬度坐标
pointToPixel(point: Point)Pixel经纬度坐标转换为像素坐标
事件
事件参数描述
click{type, target, point, pixel, overlay}左键单击地图时触发此事件。 当双击时,产生的事件序列为: click click dblclick
dblclick{type, target, pixel, point}鼠标双击地图时会触发此事件
rightclick{type, target, point, pixel, overlay}右键单击地图时触发此事件。 当双击时,产生的事件序列为: rightclick rightclick rightdblclick
rightdblclick{type, target, point, pixel, overlay}右键双击地图时触发此事件
maptypechange{type, target}地图类型发生变化时触发此事件
mousemove{type, target, point, 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}停止拖拽地图时触发
addtilelayer{type, target}添加一个自定义地图图层时触发此事件
removetilelayer{type, target}移除一个自定义地图图层时触发此事件
load{type, target, pixel, point, zoom}调用Map.centerAndZoom()方法时会触发此事件。这表示位置、缩放层级已经确定,但可能还在载入地图图块
resize{type, target, size}地图可视区域大小发生变化时会触发此事件
hotspotclick{type, target, spots}点击热区时触发此事件
hotspotover{type, target, spots}鼠标移至热区时触发此事件
hotspotout{type, target, spots}鼠标移出热区时触发此事件
tilesloaded{type, target}当地图所有图块完成加载时触发此事件
touchstart{type, target, point,pixel}触摸开始时触发此事件,仅适用移动设备
touchmove{type, target, point,pixel}触摸移动时触发此事件,仅适用移动设备
touchend{type, target, point,pixel}触摸结束时触发此事件,仅适用移动设备
longpress{type, target, point,pixel}长按事件,仅适用移动设备
MapOptions
此类表示Map构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
minZoomNumber地图允许展示的最小级别
maxZoomNumber地图允许展示的最大级别
mapTypeMapType地图类型,默认为BMAP_NORMAL_MAP
enableHighResolutionBoolean是否启用使用高分辨率地图。在iPhone4及其后续设备上,可以通过开启此选项获取更高分辨率的底图,v1.2,v1.3版本默认不开启,v1.4默认为开启状态
enableAutoResizeBoolean是否自动适应地图容器变化,默认启用
enableMapClickBoolean是否开启底图可点功能,默认启用
PanOptions
此类是panBy和panTo方法的可选参数,没有构造函数,通过对象字面量形式表示。
属性
属性类型描述
noAnimationBoolean是否在平移过程中禁止动画
Viewport
此类代表视野,不可实例化,通过对象字面量形式表示。
属性
属性类型描述
centerPoint视野中心点
zoomNumber视野级别
ViewportOptions
此类作为map.getViewport与map.setViewport方法的可选参数,不可实例化。
属性
属性类型描述
enableAnimationBoolean是否启用动画效果移动地图,默认为true。当调整后的级别与当前地图级别一致时,将使用动画效果移动地图
marginsArray<Number>视野调整的预留边距,例如: margins: [30, 20, 0, 20] 表示坐标点会限制在上述区域内
zoomFactorNumber地图级别的偏移量,您可以在方法得出的结果上增加一个偏移值。例如map.setViewport计算出地图的级别为10,如果zoomFactor为-1,则最终的地图级别为9
delayNumber改变地图视野的延迟执行时间,单位毫秒,默认为200ms。此延时仅针对动画效果有效
APIVersion
此常量表示API版本号,通过字符串进行描述。
常量
常量描述
BMAP_API_VERSION返回当前API版本。例如,1.2版本返回字符串“1.2”
MapStyle
该类用于设置地图样式,使用对象字面量形式表示,不可实例化。
属性
属性类型描述
featuresArray设置地图上展示的元素种类,支持point(兴趣点)、road(道路)、water(河流)、land(陆地)、building(建筑物)
stylestring设置地图底图样式,目前支持normal(默认样式),dark(深色样式),light(浅色样式)三种

基础类

Point
此类表示一个地理坐标点。
构造函数
构造函数描述
Point(lng: Number, lat: Number)以指定的经度和纬度创建一个地理点坐标
属性
属性类型描述
lngNumber地理经度
latNumber地理纬度
方法
方法返回值描述
equals(other: Point)Boolean判断坐标点是否相等,当且仅当两点的经度和纬度均相等时返回true
Pixel
此类表示地图上的一点,单位为像素。
构造函数
构造函数描述
Pixel(x: Number, y: Number)创建像素点对象实例。像素坐标的坐标原点为地图区域的左上角
属性
属性类型描述
xNumberx坐标
yNumbery坐标
方法
方法返回值描述
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)以指定的宽度和高度创建一个矩形区域大小对象
属性
属性类型描述
widthNumber水平方向的数值
heightNumber竖直方向的数值
方法
方法返回值描述
equals(other: Size)Boolean当且仅当此矩形中的宽度和高度都等于其他矩形的宽度和高度时,返回true

控件类

Control
此类是所有控件的基类,您可以通过此类来实现自定义控件。所有控件均包含Control类的属性、方法和事件。通过Map.addControl()方法可将控件添加到地图上。
构造函数
构造函数描述
Control()创建一个控件原型实例,通过该原型实例可创建自定义控件
属性
属性类型描述
defaultAnchorControlAnchor控件默认的停靠位置。自定义控件时需要提供此属性,作为控件的默认停靠位置
defaultOffsetSize控件默认的位置偏移值。自定义控件时需要提供此属性,作为控件的默认偏移位置
方法
方法返回值描述
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控件将定位到地图的右下角
NavigationControl
此类表示地图的平移缩放控件,可以对地图进行上下左右四个方向的平移和缩放操作。
构造函数
构造函数描述
NavigationControl(type: NavigationControlOptions)创建一个特定样式的地图平移缩放控件
方法
方法返回值描述
getType()NavigationControlType返回平移缩放控件的类型
setType(type: NavigationControlType)none设置平移缩放控件的类型
NavigationControlOptions
此类表示NavigationControl构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
anchorControlAnchor控件的停靠位置
offsetSize控件的水平偏移值
typeNavigationControlType平移缩放控件的类型
showZoomInfoBoolean是否显示级别提示信息
enableGeolocationBoolean控件是否集成定位功能,默认为false
NavigationControlType
此常量表示平移缩放控件的类型。
常量
常量描述
BMAP_NAVIGATION_CONTROL_LARGE标准的平移缩放控件(包括平移、缩放按钮和滑块)
BMAP_NAVIGATION_CONTROL_SMALL仅包含平移和缩放按钮
BMAP_NAVIGATION_CONTROL_PAN仅包含平移按钮
BMAP_NAVIGATION_CONTROL_ZOOM仅包含缩放按钮
GeolocationControl
此类是负责进行地图定位的控件,使用html5浏览器定位功能,此类继承Control所有功能。
构造函数
构造函数描述
GeolocationControl(type: GeolocationControlOptions)创建一个特定样式的地图定位控件
方法
方法返回值描述
location()none开始进行定位
getAddressComponent()AddressComponent返回当前的定位信息。若当前还未定位,则返回null
事件
事件参数描述
locationSuccess{point, AddressComponent}定位成功后触发此事件
locationError{StatusCode}定位失败后触发此事件
GeolocationControlOptions
此类表示GeolocationControl构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
anchorControlAnchor控件的停靠位置,默认定位到地图的右下角
offsetSize控件的水平偏移值
showAddressBarBoolean是否显示定位信息面板。默认显示定位信息面板
enableAutoLocationBoolean添加控件时是否进行定位。默认添加控件时不进行定位
locationIconIcon可自定义定位中心点的Icon样式
OverviewMapControl
此类表示缩略地图控件。
构造函数
构造函数描述
OverviewMapControl(opts: OverviewMapControlOptions)创建一个缩略地图控件实例
方法
方法返回值描述
changeView()none切换缩略地图控件的开合状态
setSize(size: Size)none设置缩略地图的大小
getSize()Size返回缩略地图的大小
事件
事件参数描述
viewchangedevent{type, target, isOpen}缩略地图开合状态发生变化后触发此事件
viewchangingevent{type, target}缩略地图开合状态发生变化过程中触发此事件
OverviewMapControlOptions
此类表示OverviewMapControl构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
anchorControlAnchor控件的停靠位置
offsetSize控件的偏移值
sizeSize缩略地图控件的大小
isOpenBoolean缩略地图添加到地图后的开合状态,默认为关闭
ScaleControl
此类表示比例尺控件。
构造函数
构造函数描述
ScaleControl(opts: ScaleControlOptions)创建一个比例尺控件
方法
方法返回值描述
getUnit()LengthUnit返回比例尺单位制
setUnit(unit: LengthUnit)none设置比例尺单位制
ScaleControlOptions
此类表示ScaleControl构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
anchorControlAnchor控件的停靠位置
offsetSize控件的偏移值
LengthUnit
常量表示长度单位制。
常量
常量描述
BMAP_UNIT_METRIC公制单位
BMAP_UNIT_IMPERIAL英制单位
CopyrightControl
此类表示版权控件,您可以在地图上添加自己的版权信息。每一个版权信息需要包含如下内容:版权的唯一标识、版权内容和其适用的区域范围。
构造函数
构造函数描述
CopyrightControl(opts: CopyrightControlOptions)创建一个版权控件实例
方法
方法返回值描述
addCopyright(copyright: Copyright)none添加版权信息
removeCopyright(id: number)none移除版权信息
getCopyright(id: number)Copyright返回单个版权信息
getCopyrightCollection()Array<Copyright>返回版权信息列表
CopyrightControlOptions
此类表示CopyrightControl构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
anchorControlAnchor控件的停靠位置
offsetSize控件的偏移值
Copyright
此类表示一条版权信息。可作为CopyrightControl.addCopyright()方法的参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
idNumber该版权信息的唯一标识符
contentString该版权的文本信息,用于显示在地图上,支持HTML内容
boundsBounds该版权信息所适用的地理区域
MapTypeControl
此类是负责切换地图类型的控件,此类继承Control所有功能。
构造函数
构造函数描述
MapTypeControl(opts: MapTypeControlOptions)创建地图类型控件
MapTypeControlOptions
此类表示MapTypeControl构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
typeMapTypeControlType控件样式
mapTypesArray<MapType>控件展示的地图类型,默认为普通图、卫星图、卫星加路网混合图和三维图。通过此属性可配置控件展示的地图类型
MapTypeControlType
此常量表示MapTypeControl的外观样式。
常量
常量描述
BMAP_MAPTYPE_CONTROL_HORIZONTAL按钮水平方式展示,默认采用此类型展示
BMAP_MAPTYPE_CONTROL_DROPDOWN按钮呈下拉列表方式展示
BMAP_MAPTYPE_CONTROL_MAP以图片方式展示类型控件,设置该类型后无法指定maptypes属性
PanoramaControl
此类是负责切换至全景地图的控件,此类继承Control所有功能。
构造函数
构造函数描述
PanoramaControl()创建全景控件实例
StatusCode
此常量用于描述对象当前状态。
常量
常量描述
BMAP_STATUS_PERMISSION_DENIED没有权限。对应数值“6”
BMAP_STATUS_SERVICE_UNAVAILABLE服务不可用。对应数值“7”
BMAP_STATUS_TIMEOUT超时。对应数值“8”

覆盖物类

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方法可获得该对象实例。
属性
属性类型描述
floatPaneHTMLElement信息窗口所在的容器
markerMouseTargetHTMLElement标注点击区域所在的容器
floatShadowHTMLElement信息窗口阴影所在的容器
labelPaneHTMLElement文本标注所在的容器
markerPaneHTMLElement标注图标所在的容器
markerShadowHTMLElement标注阴影所在的容器
mapPaneHTMLElement折线、多边形等矢量图形所在的容器
Marker
此类表示地图上一个图像标注。
构造函数
构造函数描述
Marker(point: Point, opts: MarkerOptions)创建一个图像标注实例。point参数指定了图像标注所在的地理位置
方法
方法返回值描述
openInfoWindow(infoWnd: InfoWindow)none打开信息窗
closeInfoWindow()none关闭信息窗
setIcon(icon: Icon)none设置标注所用的图标对象
getIcon()Icon返回标注所用的图标对象
setPosition(position: Point)none设置标注的地理坐标
getPosition()Point返回标注的地理坐标
setOffset(offset: Size)none设置标注的偏移值
getOffset()Size返回标注的偏移值
getLabel()Label返回标注的文本标注
setLabel(label: Label)none为标注添加文本标注
setTitle(title: String)none设置标注的标题,当鼠标移至标注上时显示此标题
getTitle()String返回标注的标题
setTop(isTop: Boolean)none将标注置于其他标注之上。默认情况下,纬度较低的标注会覆盖在纬度较高的标注之上,从而形成一种立体效果。通过此方法可使某个标注覆盖在其他所有标注之上。注意:如果在多个标注对象上调用此方法,则这些标注依旧按照纬度产生默认的覆盖效果
enableDragging()none开启标注拖拽功能
disableDragging()none关闭标注拖拽功能
enableMassClear()none允许覆盖物在map.clearOverlays方法中被清除
disableMassClear()none禁止覆盖物在map.clearOverlays方法中被清除
setZIndex(zIndex: Number)none设置覆盖物的zIndex
getMap()Map返回覆盖物所在的map对象
addContextMenu(menu: ContextMenu)none添加右键菜单
removeContextMenu(menu: ContextMenu)none移除右键菜单
setAnimation(animation: Animation | Null)none设置标注动画效果。如果参数为null,则取消动画效果。该方法需要在addOverlay方法后设置
setRotation(rotation: Number)none设置点的旋转角度
getRotation()Number获取点的旋转角度
setShadow(shadow: Icon)none设置标注阴影图标
getShadow()Icon获取标注阴影图标
addEventListener(event: String, handler: Function)none添加事件监听函数
removeEventListener(event: String, handler: Function)none移除事件监听函数
事件
事件参数描述
clickevent{type, target}点击标注图标后会触发此事件
dblclickevent{type, target, point,pixel}双击标注图标后会触发此事件
mousedownevent{type, target, point,pixel}鼠标在标注图上按下触发此事件
mouseupevent{type, target, point,pixel}鼠标在标注图上释放触发此事件
mouseoutevent{type, target, point,pixel}鼠标离开标注时触发此事件
mouseoverevent{type, target, point,pixel}当鼠标进入标注图标区域时会触发此事件
removeevent{type, target}移除标注时触发
infowindowcloseevent{type, target}信息窗在此标注上关闭时触发此事件
infowindowopenevent{type, target}信息窗在此标注上打开时触发此事件
dragstartevent{type, target}开始拖拽标注时触发此事件
draggingevent{type, target, pixel, point}拖拽标注过程中触发此事件
dragendevent{type, target, pixel, point}拖拽结束时触发此事件
rightclickevent{type, target}右键点击标注时触发此事件
MarkerOptions
此类表示Marker构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
offsetSize标注的位置偏移值
iconIcon标注所用的图标对象
enableMassClearBoolean是否在调用map.clearOverlays清除此覆盖物,默认为true
enableDraggingBoolean是否启用拖拽,默认为false
enableClickingBoolean是否响应点击事件。默认为true
raiseOnDragBoolean拖拽标注时,标注是否开启离开地图表面效果。默认为false
draggingCursorString拖拽标注时的鼠标指针样式。此属性值需遵循CSS的cursor属性规范
rotationNumber旋转角度
shadowIcon阴影图标
titleString鼠标移到marker上的显示内容
Animation
此常量表示标注的动画效果。
常量
常量描述
BMAP_ANIMATION_DROP坠落动画
BMAP_ANIMATION_BOUNCE跳动动画
Icon
此类表示标注覆盖物所使用的图标。
构造函数
构造函数描述
Icon(url: String, size: Size, opts: IconOptions)以给定的图像地址和大小创建图标对象实例
属性
属性类型描述
anchorSize图标的定位点相对于图标左上角的偏移值
sizeSize图标可视区域的大小
imageOffsetSize图标所用的图片相对于可视区域的偏移值,此功能的作用等同于CSS中的background-position属性
imageSizeSize图标所用的图片的大小,此功能的作用等同于CSS中的background-size属性。可用于实现高清屏的高清效果
imageUrlString图标所用图像资源的位置
infoWindowAnchorSize信息窗口开启位置相对于图标左上角的偏移值
printImageUrlString设置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设置图片相对于可视区域的偏移值
setInfoWindowAnchor(anchor: Size)none设置信息窗口开启位置相对于图标左上角的偏移值
setPrintImageUrl(url: String)none设置icon的打印图片,该打印图片只针对IE6有效,解决IE6使用PNG滤镜导致的错位问题。如果您的icon没有使用PNG格式图片或者没有使用CSS Sprites技术,则可忽略此配置
IconOptions
此类表示Icon构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
anchorSize图标的定位锚点。此点用来决定图标与地理位置的关系,是相对于图标左上角的偏移值,默认等于图标宽度和高度的中间值
imageOffsetSize图片相对于可视区域的偏移值
infoWindowAnchorSize信息窗口定位锚点。开启信息窗口时,信息窗口底部尖角相对于图标左上角的位置,默认等于图标的anchor
printImageUrlString用于打印的图片,此属性只适用于IE6,为了解决IE6在包含滤镜的情况下打印样式不正确的问题
InfoWindow
此类表示地图上包含信息的窗口。
构造函数
构造函数描述
InfoWindow(content: String | HTMLElement, opts: InfoWindowOptions)创建一个信息窗实例,其中content支持HTML内容。1.2版本开始content参数支持传入DOM结点
方法
方法返回值描述
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移除事件监听函数
事件
事件参数描述
closeevent{type, target, point}信息窗口被关闭时触发此事件
openevent{type, target, point}信息窗口被打开时触发此事件
maximizeevent{type, target}信息窗口最大化后触发此事件
restoreevent{type, target}信息窗口还原时触发此事件
clickcloseevent{type, target}点击信息窗口的关闭按钮时触发此事件
InfoWindowOptions
此类表示InfoWindow构造函数的可选参数,它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
widthNumber信息窗宽度,单位像素。取值范围:0, 220 - 730。如果您指定宽度为0,则信息窗口的宽度将按照其内容自动调整
heightNumber信息窗高度,单位像素。取值范围:0, 60 - 650。如果您指定高度为0,则信息窗口的高度将按照其内容自动调整
maxWidthNumber信息窗最大化时的宽度,单位像素。取值范围:220 - 730
offsetSize信息窗位置偏移值。默认情况下在地图上打开的信息窗底端的尖角将指向其地理坐标,在标注上打开的信息窗底端尖角的位置取决于标注所用图标的infoWindowOffset属性值,您可以为信息窗添加偏移量来改变默认位置
titleString信息窗标题文字,支持HTML内容
enableAutoPanBoolean是否开启信息窗口打开时地图自动移动(默认开启)
enableCloseOnClickBoolean是否开启点击地图关闭信息窗口(默认开启)
enableMessageBoolean是否在信息窗里显示短信发送按钮(默认开启)
messageString自定义部分的短信内容,可选项。完整的短信内容包括:自定义部分+位置链接,不设置时,显示默认短信内容。短信内容最长为140个字
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移除事件监听函数
事件
事件参数描述
clickevent{type, target}点击文本标注后会触发此事件
dblclickevent{type, target}双击文本标注后会触发此事件
mousedownevent{type, target}鼠标在文本标注上按下触发此事件
mouseupevent{type, target}鼠标在文本标注释放触发此事件
mouseoutevent{type, target}鼠标离开文本标注时触发此事件
mouseoverevent{type, target}当鼠标进入文本标注区域时会触发此事件
removeevent{type, target}移除文本标注时触发
rightclickevent{type, target}右键点击标注时触发此事件
LabelOptions
此类表示Lable构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
offsetSize文本标注的位置偏移值
positionPoint文本标注的地理位置
enableMassClearBoolean是否在调用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移除事件监听函数
事件
事件参数描述
clickevent{type, target, point, pixel}点击折线后会触发此事件
dblclickevent{type, target, point, pixel}双击折线后会触发此事件
mousedownevent{type, target, point, pixel}鼠标在折线上按下触发此事件
mouseupevent{type, target, point, pixel}鼠标在折线释放触发此事件
mouseoutevent{type, target, point, pixel}鼠标离开折线时触发此事件
mouseoverevent{type, target, point, pixel}当鼠标进入折线区域时会触发此事件
removeevent{type, target}移除折线时触发
lineupdateevent{type, target}覆盖物的属性发生变化时触发
PolylineOptions
此类表示Polyline构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
strokeColorString折线颜色
strokeWeightNumber折线的宽度,以像素为单位
strokeOpacityNumber折线的透明度,取值范围0 - 1
strokeStyleString折线的样式,solid或dashed
enableMassClearBoolean是否在调用map.clearOverlays清除此覆盖物,默认为true
enableEditingBoolean是否启用线编辑,默认为false
enableClickingBoolean是否响应点击事件,默认为true
iconsArray<IconSequence>配置贴合折线的图标
IconSequence
此类用于设置polyline上的符号显示。
构造函数
构造函数描述
IconSequence(symbol: Symbol, offset: string, repeat: string, fixedRotation: boolean)创建线上的符号类。symbol为符号样式;offset为符号相对于线起点的位置,取值可以是百分比也可以是像素位置,默认为"100%";repeat为符号在线上重复显示的距离,可以是百分比也可以是距离值,同时设置repeat与offset时,以repeat为准;fixedRotation设置图标的旋转角度是否与线走向一致,默认为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移除事件监听函数
事件
事件参数描述
clickevent{type, target, point, pixel}点击多边形后会触发此事件
dblclickevent{type, target, point, pixel}双击多边形后会触发此事件
mousedownevent{type, target, point, pixel}鼠标在多边形上按下触发此事件
mouseupevent{type, target, point, pixel}鼠标在多边形释放触发此事件
mouseoutevent{type, target, point, pixel}鼠标离开多边形时触发此事件
mouseoverevent{type, target, point, pixel}当鼠标进入多边形区域时会触发此事件
removeevent{type, target}移除多边形时触发
lineupdateevent{type, target}覆盖物的属性发生变化时触发
PolygonOptions
此类表示Polygon构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
strokeColorString边线颜色
fillColorString填充颜色。当参数为空时,折线覆盖物将没有填充效果
strokeWeightNumber边线的宽度,以像素为单位
strokeOpacityNumber边线透明度,取值范围0 - 1
fillOpacityNumber填充的透明度,取值范围0 - 1
strokeStyleString边线的样式,solid或dashed
enableMassClearBoolean是否在调用map.clearOverlays清除此覆盖物,默认为true
enableEditingBoolean是否启用线编辑,默认为false
enableClickingBoolean是否响应点击事件,默认为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移除事件监听函数
事件
事件参数描述
clickevent{type, target, point, pixel}鼠标点击圆形后会触发此事件
dblclickevent{type, target, point, pixel}鼠标双击圆形后会触发此事件
mousedownevent{type, target, point, pixel}鼠标在圆形上按下触发此事件
mouseupevent{type, target, point, pixel}鼠标在圆形释放触发此事件
mouseoutevent{type, target, point, pixel}鼠标离开圆形时触发此事件
mouseoverevent{type, target, point, pixel}当鼠标进入圆形区域时会触发此事件
removeevent{type, target}移除圆形时触发此事件
lineupdateevent{type, target}圆形覆盖物的属性发生变化时触发此事件
CircleOptions
Circle类构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
strokeColorString圆形边线颜色
fillColorString圆形填充颜色。当参数为空时,圆形将没有填充效果
strokeWeightNumber圆形边线的宽度,以像素为单位
strokeOpacityNumber圆形边线透明度,取值范围0 - 1
fillOpacityNumber圆形填充的透明度,取值范围0 - 1
strokeStyleString圆形边线的样式,solid或dashed
enableMassClearBoolean是否在调用map.clearOverlays清除此覆盖物,默认为true
enableEditingBoolean是否启用线编辑,默认为false
enableClickingBoolean是否响应点击事件,默认为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返回图层显示的最大级别
事件
事件参数描述
clickevent{type, target}鼠标点击图层后会触发此事件
dblclickevent{type, target}鼠标双击图层后会触发此事件
GroundOverlayOptions
GroundOverlay类构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
opacityNumber图层透明度
imageURLString图层地址
displayOnMinLevelNumber图层显示的最小级别
displayOnMaxLevelNumber图层显示的最大级别
PointCollection
此类表示海量点类,利用该类可同时在地图上展示万级别的点,目前仅适用于html5浏览器。
构造函数
构造函数描述
PointCollection(points: Array<Point>, opts: PointCollectionOptions)创建海量点类。points为点的坐标集合,opts为点的绘制样式
方法
方法返回值描述
setPoints(points: Array<Point>)none设置要在地图上展示的点坐标集合
setStyles(styles: PointCollectionOption)none点的样式,包括:大小"size"(可选,默认正常尺寸10*10px,SizeType类型),形状"shape"(可选,默认圆形,ShapeType类型),颜色"color"(可选,字符串类型)
clear()none清除海量点
事件
事件参数描述
clickevent{type, target,point}鼠标点击点时会触发此事件
mouseoverevent{type, target,point}鼠标移入点时会触发该事件
mouseoutevent{type, target,point}鼠标移出点时会触发该事件
PointCollectionOptions
该类是PointCollections的可选参数,没有构造函数,通过对象字面量形式表示。
属性
属性类型描述
shapeShapeType海量点的预设形状
colorString海量点的颜色,默认为'#fa937e',同时支持颜色字符串,如'red';哈希字符串'#000000';rgb字符串,如'rgb(0,0,0)’;rgba字符串,如'rgb(255,0,0,0.1)';hsl字符串,如'hsl(0,100%,50%)';hsla字符串,如'hsla(0,100%,50%,0.4)'
sizeSizeType海量点的预设尺寸
ShapeType
此枚举类型表示海量点预设的不同形状。
常量
常量描述
BMAP_POINT_SHAPE_CIRCLE圆形,为默认形状
BMAP_POINT_SHAPE_STAR星形
BMAP_POINT_SHAPE_SQUARE方形
BMAP_POINT_SHAPE_RHOMBUS菱形
BMAP_POINT_SHAPE_WATERDROP水滴状,该类型无size和color属性
SizeType
此枚举类型表示海量点预设的不同尺寸。
常量
常量描述
BMAP_POINT_SIZE_TINY定义点的尺寸为超小,宽高为2px*2px
BMAP_POINT_SIZE_SMALLER定义点的尺寸为很小,宽高为4px*4px
BMAP_POINT_SIZE_SMALL定义点的尺寸为小,宽高为8px*8px
BMAP_POINT_SIZE_NORMAL定义点的尺寸为正常,宽高为10px*10px,为海量点默认尺寸
BMAP_POINT_SIZE_BIG定义点的尺寸为大,宽高为16px*16px
BMAP_POINT_SIZE_BIGGER定义点的尺寸为很大,宽高为20px*20px
BMAP_POINT_SIZE_HUGE定义点的尺寸为超大,宽高为30px*30px
Hotspot
此类表示地图上的一个热区。
构造函数
构造函数描述
Hotspot(position: Point, options: HotspotOptions)创建Hotspot对象实例
方法
方法返回值描述
getPosition()Point获取热区位置坐标
setPosition(position: Point)None设置热区位置坐标
getText()String获取热区提示文本
setText(text: String)None设置热区提示文本
getUserData()Mix获取热区对应的用户数据
setUserData(data: Mix)None设置热区对应的用户数据
HotspotOptions
此类是addHotspot方法的可选参数,没有构造函数,通过对象字面量形式表示。
属性
属性类型描述
textString当鼠标移至某一热区上时出现的文字提示
offsetsArray热区响应区域距中心点的扩展偏移值。数组的四个数值分别表示上、右、下、左距离中心点的扩展偏移量。默认偏移量为[5, 5, 5, 5]
userDataMix由用户填入的自定义数据
minZoomNumber热区生效的最小级别
maxZoomNumber热区生效的最大级别
Symbol
此类表示通过svg的path string创建的矢量图标类。
构造函数
构造函数描述
Symbol(path: String | SymboShapeType, opts: SymbolOptions)创建一个矢量图标实例。path为svg中的path字符串或者已定义的符号常量,opts为矢量图标的样式
方法
方法返回值描述
setPath(path: string | SymbolShape)none设置矢量图标的路径
setAnchor(anchor: Size)none设置矢量图标的定位点,该定位点的位置以图标自身为基准
setRotation(rotation: number)none设置矢量图标的旋转角度,参数为角度
setScale(scale: number)none设置矢量图标的缩放比例
setStrokeWeight(strokeWeight: number)none设置矢量图标的线宽
setStrokeColor(color: string)none设置矢量图标的线填充颜色,支持颜色常量字符串、十六进制、RGB、RGBA等格式
setStrokeOpacity(opacity: number)none设置矢量图标线的透明度,opacity范围0~1
setFillOpacity(opacity: number)none设置矢量图标填充透明度,opacity范围0~1
setFillColor(color: string)none设置矢量图标的填充颜色。支持颜色常量字符串、十六进制、RGB、RGBA等格式
SymbolOptions
此类表示Symbol构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
anchorSize符号的位置偏移值
fillColorstring设置矢量图标的填充颜色。支持颜色常量字符串、十六进制、RGB、RGBA等格式
fillOpacityNumber设置矢量图标填充透明度,范围0~1
scaleNumber设置矢量图标的缩放比例
rotationNumber设置矢量图标的旋转角度,参数为角度
strokeColorstring设置矢量图标的线填充颜色,支持颜色常量字符串、十六进制、RGB、RGBA等格式
strokeOpacityNumber设置矢量图标线的透明度,opacity范围0~1
strokeWeightNumber旋设置线宽。如果此属性没有指定,则线宽跟scale数值相同
CanvasLayer
用于在地图上绘制自定义的canvas2D或WebGL图形。
构造函数
构造函数描述
CanvasLayer(opts: CanvasLayerOptions)创建一个CanvasLayer实例,每个实例都是一个单独的canvas标签即单独的一层。可以为同一个地图添加多层的CanvasLayer叠加。
CanvasLayerOptions
此类表示CanvasLayer构造函数的可选参数。它没有构造函数,但可以通过对象字面量形式标识。
属性
属性类型描述
zIndexNumber对应canvas的css z-index属性,当添加了多个CanvasLayer时,可以用于设置层叠顺序
paneNameStringCanvasLayer位于的覆盖物层级,例:paneName: floatPane。JSAPI把地图覆盖物分为了8个层级,顶层为'floatPane', 低层为'vertexPane'。可以通过Map实例的getPanes()方法,获取到8个层级的名称
updateFunction具体的绘制逻辑。通过this.canvas获取当前的canvas对象
SymbolShapeType
此枚举类型表示矢量图标类预设的图标样式。
常量
常量描述
BMap_Symbol_SHAPE_CIRCLE圆形,默认半径为1px
BMap_Symbol_SHAPE_RECTANGLE矩形,默认宽度4px、高度2px
BMap_Symbol_SHAPE_RHOMBUS菱形,默认外接圆半径10px
BMap_Symbol_SHAPE_STAR五角星,五角星外接圆半径为10px
BMap_Symbol_SHAPE_BACKWARD_CLOSED_ARROW箭头方向向下的闭合箭头
BMap_Symbol_SHAPE_FORWARD_CLOSED_ARROW箭头方向向上的闭合箭头
BMap_Symbol_SHAPE_BACKWARD_OPEN_ARROW箭头方向向下的非闭合箭头
BMap_Symbol_SHAPE_FORWARD_OPEN_ARROW箭头方向向上的非闭合箭头
BMap_Symbol_SHAPE_POINT定位点图标
BMap_Symbol_SHAPE_PLANE预设的飞机形状
BMap_Symbol_SHAPE_CAMERA预设的照相机形状
BMap_Symbol_SHAPE_WARNING预设的警告符号
BMap_Symbol_SHAPE_SMILE预设的笑脸形状
BMap_Symbol_SHAPE_CLOCK预设的钟表形状

右键菜单类

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

地图类型类

MapType
此类表示一种地图类型,您可以通过实例化此类自定义地图类型。
构造函数
构造函数描述
MapType(name: String, layers: TileLayer | Array<TileLayer>, options: MapTypeOptions)创建MapType对象实例
方法
方法返回值描述
getName()String返回地图类型名称
getTileLayer()TileLayer返回地图类型对应的图层
getMinZoom()Number返回地图类型允许的最小级别
getMaxZoom()Number返回地图类型允许的最大级别
getProjection()Projection返回地图类型所使用的投影实例
getTextColor()String返回地图类型对应的前景色
getTips()String返回地图类型的提示说明,用于在地图类型控件中提示
常量
常量描述
BMAP_NORMAL_MAP此地图类型展示普通街道视图
BMAP_PERSPECTIVE_MAP此地图类型展示透视图像视图
BMAP_SATELLITE_MAP此地图类型展示卫星视图
BMAP_HYBRID_MAP此地图类型展示卫星和路网的混合视图
MapTypeOptions
此类是MapType构造函数的可选参数,不能实例化,通过对象字面量形式表示。
属性
属性类型描述
minZoomNumber该类型地图的最小级别
maxZoomNumber该类型地图的最大级别
errorImageUrlString当没有图块时所显示的错误图片地址。默认为透明图
textColorNumber地图类型对应的前景色
tipsString提示说明信息,用于在地图类型控件中进行提示
Projection
此类表示地图投影抽象基类,不可实例化,但可通过MapType的getProjection方法获得。
方法
方法返回值描述
lngLatToPoint(lngLat: Point)Pixel抽象,根据球面坐标获得平面坐标
pointToLngLat(point: Pixel)Point抽象,根据平面坐标获得球面坐标
MercatorProjection
此类表示街道地图投影类,一般通过MapType的getProjection方法获得实例。
方法
方法返回值描述
lngLatToPoint(lngLat: Point)Pixel根据球面坐标获得平面坐标
pointToLngLat(point: Pixel)Point根据平面坐标获得球面坐标
PerspectiveProjection
此类表示透视地图投影类,一般通过MapType的getProjection方法获得实例。
方法
方法返回值描述
lngLatToPoint(lngLat: Point)Pixel根据球面坐标获得平面坐标
pointToLngLat(point: Pixel)Point根据平面坐标获得球面坐标

地图图层类

TileLayer
此类表示一个地图图层,您可以向地图中添加自定义图层。
构造函数
构造函数描述
TileLayer(opts: TileLayerOptions)创建一个地图图层实例
方法
方法返回值描述
getTilesUrl(tileCoord: Pixel, zoom: Number)String抽象。向地图返回地图图块的网址,图块索引由tileCoord的x和y属性在指定的缩放级别zoom提供。如果您在TileLayerOptions中提供了tileUrlTemplate参数,则可不实现此接口
getCopyright()Copyright | Null返回地图图层数据的版权对象
isTransparentPng()Number如果图层所用的图片为PNG格式并且包含透明信息,则返回true
TileLayerOptions
此类表示TileLayer构造函数的可选参数
属性
属性类型描述
transparentPngBoolean是否使用了带有透明信息的PNG。由于IE6不支持PNG透明,因此需要特殊处理
tileUrlTemplateString指定图块网址模板,该模板可以针对每个图块请求而展开,以根据现有的图块坐标系引用唯一的图块。模板的格式应该为: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()抽象方法
copyrightCopyright地图图层的版权信息
zIndexNumber图层的zIndex
TrafficLayer
此类表示交通流量图层
构造函数
构造函数描述
TrafficLayer(opts: TrafficLayerOptions)创建交通流量图层。参数:opts: TrafficLayerOptions,可选 options 参数指定应作为对象常量传递。如果可选参数提供predictDate,则将显示预测流量。否则显示实时流量
TrafficLayerOptions
此类是TrafficLayer构造函数的可选参数,没有构造函数,不能实例化。
属性
属性类型描述
predictDatePredictDate预测日期
PredictDate
此类表示交通流量的预测日期,没有构造函数,通过对象字面量形式表示。
属性
属性类型描述
weekdayNumber预测日期,取值1到7,表示周一到周日
hourNumber预测小时数,取值0到23,表示当日的0点到23点
CustomLayer
CustomLayer是用户自定义底图层,现阶段主要为LBS云麻点功能展现服务。
构造函数
构造函数描述
CustomLayer(CustomLayerOptions: opts)创建自定义底图层
事件
事件参数描述
hotspotclickevent{type, target, content}点击热区触发,content即为lbs云详情检索的所有字段,参考http://developer.baidu.com/map/lbs-geosearch.htm#.search.detail
CustomLayerOptions
此类表示CustomLayer构造函数的可选参数。
属性
属性类型描述
databoxIdString使用云检索v1版本的databoxId
geotableIdString使用云检索v2版本的geotableId
qString检索关键字
tagsString空格分隔的多字符串
filterString过滤条件,参考http://developer.baidu.com/map/lbs-geosearch.htm#.search.nearby
pointDensityTypeEnum PointDensityType麻点密度常量
Custompoi
此类表示点击麻点图返回的,没有构造函数,通过对象字面量形式表示。
属性
属性类型描述
poiIdString返回数据的id
databoxIdString数据集的id
titleString结果的名称标题
addressString地址
phoneNumberString电话
postcodeString邮政编码
provinceCodeNumber结果所在省的编码
provinceString结果所在省的名称
cityCodeNumber结果所在城市的编码
cityString结果所在城市的名称
districtCodeNumber结果所在区县的编码
districtString结果所在区县的名称
pointPoint结果所在的地理位置
tagsArray <String>结果的筛选标签
typeIdNumber结果的类别id
extendedDataJson用户扩展数据,结构根据用户的自定义
PanoramaCoverageLayer
此图层用来展示全景覆盖的区域。
构造函数
构造函数描述
PanoramaCoverageLayer()创建全景覆盖区域图层的实例
PointDensityType
麻点密度常量
常量
常量描述
BMAP_POINT_DENSITY_HIGH麻点密度高
BMAP_POINT_DENSITY_MEDIUM麻点密度中等,默认
BMAP_POINT_DENSITY_LOW麻点密度低

服务类

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构造函数的可选参数。
属性
属性类型描述
renderOptionsLocalRenderOptions结果呈现设置
onMarkersSetFunction标注添加完成后的回调函数。 参数: pois: Array,通过marker属性可得到其对应的标注
onInfoHtmlSetFunction标注气泡内容创建后的回调函数。 参数: poi: LocalResultPoi,通过其marker属性可得到当前的标注。 html: HTMLElement,气泡内的Dom元素
onResultsHtmlSetFunction结果列表添加完成后的回调函数。 参数: container: HTMLElement,结果列表所用的HTML元素
pageCapacityNumber设置每页容量,取值范围:1 - 100,对于多关键字检索,容量表示每个关键字的数量,如果有2个关键字,则实际检索结果数量范围为:2 - 200
onSearchCompleteFunction检索完成后的回调函数。 参数:results: LocalResult或Array 如果是多关键字检索,回调函数参数返回一个LocalResult的数组,数组中的结果顺序和检索中多关键字数组中顺序一致
CustomData
此类表示检索lbs云服务的数据。它没有构造函数,但可通过对象字面量形式表示。 要检索lbs云服务的数据,需要在引用api的时候在参数后加上lbs云平台的key。
属性
属性类型描述
geotableIdNumberlbs云v2接口,可在lbs云平台上查看自己的geotableId
tagsString空格分隔的多字符串
filterString过滤条件,参考:http://developer.baidu.com/map/index.php?title=lbscloud/api/geosearch
RenderOptions
此类表示搜索结果呈现的配置。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
mapMap展现结果的地图实例。当指定此参数后,搜索结果的标注、线路等均会自动添加到此地图上
panelString | HTMLElement结果列表的HTML容器id或容器元素,提供此参数后,结果列表将在此容器中进行展示。此属性对LocalCity无效。驾车路线规划无效
selectFirstResultBoolean是否选择第一个检索结果。此属性仅对LocalSearch有效
autoViewportBoolean检索结束后是否自动调整地图视野。此属性对LocalCity无效
LocalResult
类表示LocalSearch的检索结果,没有构造函数,通过LocalSearch.getResults()方法或LocalSearch的onSearchComplete回调函数的参数得到。
属性
属性类型描述
keywordString本次检索的关键词
centerLocalResultPoi周边检索的中心点(仅当周边检索时提供)
radiusNumber周边检索的半径(仅当周边检索时提供)
boundsBounds范围检索的地理区域(仅当范围检索时提供)
cityString本次检索所在的城市
moreResultsUrlString更多结果的链接,到百度地图进行搜索
provinceString本次检索所在的省份
suggestionsArray<String>搜索建议列表。(当关键词是拼音或拼写错误时给出的搜索建议)
方法
方法返回值描述
getPoi(i: Number)LocalResultPoi返回索引指定的结果。索引0表示第1条结果
getCurrentNumPois()Number返回当前页的结果数
getNumPois()Number返回总结果数
getNumPages()Number返回总页数
getPageIndex()Number返回页数序号
getCityList()Array<Object>返回城市列表。数组元素对象包含如下属性: city: String,城市名 numResults: Number,结果数
LocalResultPoi
此类表示位置检索或路线规划的一个结果点,没有构造函数,可通过对象字面量形式表示。
属性
属性类型描述
titleString结果的名称标题
pointPoint该结果所在的地理位置
urlString在百度地图中展示该结果点的详情信息链接
addressString地址(根据数据部分提供)。注:当结果点类型为公交站或地铁站时,地址信息为经过该站点的所有车次
cityString所在城市
phoneNumberString电话,根据数据部分提供
postcodeString邮政编码,根据数据部分提供
typePoiType类型,根据数据部分提供
isAccurateBoolean是否精确匹配。只适用LocalSearch的search方法检索的结果
provinceString所在省份
tagsArray<String>POI的标签,如商务大厦、餐馆等。目前只有LocalSearch的回调函数onSearchComplete(result)中的result和Geocoder.getLocation的回调函数的参数GeocoderResult.surroundingPois涉及的LocalResultPoi有tags字段。其他API涉及的LocalResultPoi没有该字段
detailUrlString在百度地图详情页面展示该结果点的链接。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构造函数的可选参数。它没有构造函数,但可通过对象字面量形式表示。
属性
属性类型描述
renderOptionsRenderOptions搜索结果的呈现设置
policyTransitPolicy市内公交的策略参数
intercityPolicyIntercityPolicy跨城公交的换乘策略参数
transitTypePolicyTransitTypePolicy跨城公交的交通方式策略参数
pageCapacityNumber返回方案的个数
onSearchCompleteFunction检索完成后的回调函数。参数:results: TransitRouteResult,公交导航结果
onMarkersSetFunction标注添加完成后的回调函数。参数:pois: Array ,起点和目的地数组。transfers: Array ,公交车站数组
onInfoHtmlSetFunction气泡内容创建后的回调函数。参数:poi: LocalResultPoi,表示当前气泡对应的点(可以是起点、终点或换乘车站)html: HTMLElement,气泡内的DOM元素
onPolylinesSetFunction折线添加完成后的回调函数。参数:lines: Array ,公交线路数组。routes: Array ,步行线路数组,通过Route.getPolyline()方法可得到对应的折线覆盖物
onResultsHtmlSetFunction结果列表添加完成后的回调函数。参数: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回调函数参数获得。
属性
属性类型描述
policyTransitPolicy公交导航策略
intercityPolicyIntercityPolicy跨城策略(仅跨城时有)
transitTypePolicyTransitTypePolicy跨城交通方式策略(仅跨城时有)
方法
方法返回值描述
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构造函数的可选参数。
属性
属性类型描述
renderOptionsRenderOptions搜索结果呈现设置
onSearchCompleteFunction检索完成后的回调函数。 参数: results: WalkingRouteResult
onMarkersSetFunction标注添加完成后的回调函数。 参数: pois: Array,起点和目的地点数组,。通过marker属性可得到其对应的标注
onPolylinesSetFunction折线添加完成后的回调函数。 参数: routes: Array,步行线路数组,通过Route.getPolyline()方法可得到对应的折线覆盖物
onInfoHtmlSetFunction标注气泡内容创建后的回调函数。 参数: poi: LocalResultPoi,通过其marker属性可得到当前的标注。 html: HTMLElement,气泡内的DOM元素
onResultsHtmlSetFunction结果列表添加完成后的回调函数。 参数: 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构造函数的可选参数。
属性
属性类型描述
renderOptionsRenderOptions搜索结果呈现设置
onSearchCompleteFunction检索完成后的回调函数。 参数: results: RidingRouteResult
onMarkersSetFunction标注添加完成后的回调函数。 参数: pois: Array,起点和目的地点数组,。通过marker属性可得到其对应的标注
onPolylinesSetFunction折线添加完成后的回调函数。 参数: routes: Array,骑行线路数组,通过Route.getPolyline()方法可得到对应的折线覆盖物
onInfoHtmlSetFunction标注气泡内容创建后的回调函数。 参数: poi: LocalResultPoi,通过其marker属性可得到当前的标注。 html: HTMLElement,气泡内的DOM元素
onResultsHtmlSetFunction结果列表添加完成后的回调函数。 参数: 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构造函数的可选参数。
属性
属性类型描述
renderOptionsRenderOptions结果呈现设置
policyDrivingPolicy驾车策略
onSearchCompleteFunction检索完成后的回调函数。参数: results: DrivingRouteResult
onMarkersSetFunction标注添加完成后的回调函数。 参数: pois: Array,起点和目的地点数组,通过marker属性可得到其对应的标注
onInfoHtmlSetFunction标注气泡内容创建后的回调函数。 参数: poi: LocalResultPoi,通过marker属性可得到当前的标注。html: HTMLElement,气泡内的DOM元素
onPolylinesSetFunction折线添加完成后的回调函数。 参数: routes: Array,驾车线路数组,通过Route.getPolyline()方法可得到对应的折线覆盖物
DrivingRouteResult
此类表示路线导航的结果,没有构造函数,通过DrivingRoute.getResults()方法或DrivingRoute的onSearchComplete回调函数参数获得。
属性
属性类型描述
policyDrivingPolicy驾车导航策略
方法
方法返回值描述
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
此类表示出租车费用信息,没有构造函数,通过对象字面量形式表示。
属性
属性类型描述
dayTaxiFareDetail白天费用
nightTaxiFareDetail夜间费用。注意,部分城市没有夜间费用,此时此属性为null,且同时白天费用表示全天费用
distanceNumber出租车里程,单位为米
remarkString出租车备注信息
TaxiFareDetail
此类表示出租车具体费用信息,没有构造函数,通过对象字面量形式表示。
属性
属性类型描述
initialFareNumber出租车起步价
unitFareNumber出租车单价
totalFareNumber出租车费用总价
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的地址解析结果。它在地址解析的回调函数的参数中返回,不可实例化。
属性
属性类型描述
pointPoint坐标点
addressString地址描述
addressComponentsAddressComponent结构化的地址描述
surroundingPoisArray<LocalResultPoi>附近的POI点
businessString商圈字段,代表此点所属的商圈
AddressComponent
此类表示地址解析结果的层次化地址信息,没有构造函数,通过对象字面量形式表示。
属性
属性类型描述
streetNumberString门牌号码
streetString街道名称
districtString区县名称
cityString城市名称
provinceString省份名称
LocationOptions
此类表示Geocoder的地址解析请求的可选参数。它不可实例化。
属性
属性类型描述
poiRadiusNumber附近POI所处于的最大半径,默认为100米
numPoisNumber返回的POI点个数,默认为10个。取值范围
LocalCity
此类用于获取用户所在的城市位置信息。(根据用户IP自动定位到城市)
构造函数
构造函数描述
LocalCity(opts: LocalCityOptions)创建一个获取本地城市位置的实例
方法
方法返回值描述
get(callback: Function)none当获取城市信息后,回调函数会被调用,其参数为类型为LocalCityResult对象
LocalCityOptions
此类表示LocalCity的可选参数。它没有构造函数,但可通过对象字面量表示。
属性
属性类型描述
renderOptionsRenderOptions结果呈现设置,当给定map参数时,改地图将自动将视野定位到当前城市
LocalCityResult
此类表示LocalCity的定位结果。
属性
属性类型描述
centerPoint城市所在中心点
levelNumber展示当前城市的最佳地图级别,如果您在使用此对象时提供了map实例,则地图级别将根据您提供的地图大小进行调整
nameString城市名称
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方法的回调函数参数,不可实例化。
属性
属性类型描述
pointPoint定位坐标点
accuracyNumber定位精度,单位为米
addressAddressComponent根据定位坐标点解析出的地址信息,可能为空(3.0新增)
PositionOptions
此类为getCurrentPosition的可选参数,不能实例化。
属性
属性类型描述
enableHighAccuracyBoolean是否要求浏览器获取最佳效果,同浏览器定位接口参数。默认为false
timeoutNumber超时事件,单位为毫秒。默认为10秒
maximumAgeNumber允许返回指定事件内的缓存结果,单位为毫秒。如果为0,则每次请求都获取最新的定位结果。默认为10分钟
SDKLocationBoolean是否开启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类的可选参数,没有构造参数,可以通过对象字面量表示
属性
属性类型描述
renderOptionsRenderOptionsRenderOptions结果呈现设置
onGetBusListCompleteFunction设置公交列表查询后的回调函数.参数:rs: BusListResult类型
onGetBusLineCompleteFunction设置公交线路查询后的回调函数.参数:rs: BusLine类型
onBusListHtmlSetFunction公交列表结果页渲染后回调函数.参数:container: HTMLElement,结果列表所用的HTML元素
onBusLineHtmlSetFunction公交线路结果页渲染后回调函数.参数:container: HTMLElement,结果列表所用的HTML元素
onPolylinesSetFunction添加公交线时候回调函数.参数:ply:Polyline 公交线路几何对象
onMarkersSetFunction添加公交站点时候回调函数.参数:sts:Array公交站坐标组成的Marker对象数组
BusListResult
公交列表查询成功回调函数的参数对象
属性
属性类型描述
keywordString本次检索关键字
cityString本次检索所在城市
moreResultsUrlString到百度地图查看url
方法
方法返回值描述
getNumBusList()Number公交列表个数
getBusListItem(i: Number)BusListItem获取某一个具体的公交列表中的对象。0表示上行,1表示下行
BusLine
表示公交线路结果的公交线,没有构造函数,通过检索回调函数获得。
属性
属性类型描述
nameString线路名称
startTimeString首班车时间
endTimeString末班车时间
companyString公交线路所属公司
方法
方法返回值描述
getNumBusStations()Number获取公交站点个数
getBusStation(i: Number)BusStation获取某一个具体的公交站对象
getPath()Array<Point>返回公交线地理坐标点数组
getPolyline()Polyline获取公交线几何对象, 仅当结果自动添加到地图上时有效
Line
此类表示一条公交线路,如果是跨城检索,还有可能表示一条飞机、火车或大巴线路。没有构造函数,通过TransitRoutePlan.getLine()方法得到。
属性
属性类型描述
titleString线路全称
typeLineType线路类型
方法
方法返回值描述
getNumViaStops()Number返回公交线路途径的车站个数,仅在公交和地铁类型有效
getGetOnStop()LocalResultPoi返回上车站
getGetOffStop()LocalResultPoi返回下车站
getPath()Array<Point>返回线路对应的地理坐标点数组,在公交方案中,地理坐标只给出方案涉及的部分
getPolyline()Polyline返回公交线路对应的折线覆盖物
getDistance(format: Boolean)String | Number当format为true时,返回本段公交线路的距离字符串(包含单位),当format为false时仅返回数值(单位为米)。默认参数为true
BusListItem
一个具体公交对象
属性
属性类型描述
nameString公交线名称
BusStation
公交站点对象
属性
属性类型描述
nameString站点名称
positionPoint站点坐标
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类的可选参数对象
属性
属性类型描述
locationString | Map | Point设定返回结果的所属范围。例如“北京市”
typesArray<String>返回数据类型。两种设置方式,第一种为默认值(即设置值为空),将返回所有数据。如地图初始化为北京,在输入框中输入“小”,输入框下会出现包含“小”关键字的多种类型(如餐饮、地名等)的提示词条。第二种设置值为"city",将返回省市区县乡镇街道地址类型数据。如地图初始化为北京,在输入框中输入“小”,输入框下会出现“小金县”的地点名称类的提示词条
onSearchCompleteFunction在input框中输入字符后,发起列表检索,完成后的回调函数。 参数:AutocompleteResult
inputString | HTMLElement文本输入框元素或其id
AutocompleteResultPoi
自动完成类获取的单个POI点的信息
属性
属性类型描述
provinceString省名
CityString城市名
districtString区县名称
streetString街道名称
streetNumberString门牌号码
businessString商户名
AutocompleteResult
自动完成检索完成回调函数的参数对象
属性
属性类型描述
keywordString检索关键字
方法
方法返回值描述
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
Convertor
用于将其他坐标系的坐标转换为百度坐标。
构造函数
构造函数描述
Convertor()创建一个坐标转换的实例
方法
方法返回值描述
translate(points: Array<BMap.Point>, from: number, to: number, callback: function)none对指定的点数组进行坐标转换,转换规则为从from到to,转换完成后调用callback,callback的参数为Object。一次最多10个点,from和to的含义请参照Web服务API
TranslateResults
此类是Convertor.translate()中回调函数的参数。
属性
属性类型描述
statusnumber转换结果状态吗,参考Web服务API
pointsArray<BMap.Point>转换完成的点数组,点顺序和转换前一致
StatusCode
此常量用于描述对象当前状态。
常量
常量描述
BMAP_STATUS_SUCCESS检索成功。对应数值“0”
BMAP_STATUS_CITY_LIST城市列表。对应数值“1”
BMAP_STATUS_UNKNOWN_LOCATION位置结果未知。对应数值“2”
BMAP_STATUS_UNKNOWN_ROUTE导航结果未知。对应数值“3”
BMAP_STATUS_INVALID_KEY非法密钥。对应数值“4”
BMAP_STATUS_INVALID_REQUEST非法请求。对应数值“5”
BMAP_STATUS_PERMISSION_DENIED没有权限。对应数值“6”
BMAP_STATUS_SERVICE_UNAVAILABLE服务不可用。对应数值“7”
BMAP_STATUS_TIMEOUT超时。对应数值“8”

全景类

Panorama
此类用来展示某位置的全景视图,可以单独放置在一个div容器中,也可以放在Map类的容器中。
构造函数
构造函数描述
Panorama(container: String | HTMLElement, opts: PanoramaOptions)在给定的结点中创建全景
方法
方法返回值描述
getLinks()Array<PanoramaLink>获取全景中道路指示信息
getId()String获取当前全景的id
getPosition()Point获取当前全景的位置,通过经纬度描述
getPov()PanoramaPov获取当前全景的视角
getZoom()Number获取当前全景的级别
setId(id: String)none设置全景的id
setPosition(position: Point)none设置全景的位置
setPov(pov: PanoramaPov)none设置全景的视角
setZoom(zoom: Number)none设置全景的级别
enableScrollWheelZoom()none开启鼠标滚轮缩放功能。仅对PC上有效
disableScrollWheelZoom()none关闭鼠标滚轮缩放功能
show()none显示全景
hide()none隐藏全景
addOverlay(overlay: PanoramaLabel)none全景场景内添加覆盖物
removeOverlay(overlay: PanoramaLabel)none删除全景内的覆盖物
getSceneType()Enum PanoramaSceneType获取全景的类型(室外景返回BMAP_PANORAMA_STREET_SCENE、室内景返回BMAP_PANORAMA_INDOOR_SCENE)
setOptions(opts: PanoramaOptions)none设置全景可配置参数
setPanoramaPOIType()Enum PanoramaPOIType设置全景外景场景点内可见的POI类型,默认为隐藏所有类型poi
事件
事件参数描述
position_changednone全景位置发生变化时触发
links_changednone全景相邻道路发生变化时触发,通常是在位置变化时,异步获取新数据之后触发
pov_changednone全景视角发生变化时触发
zoom_changednone全景级别发生变化时触发
scene_type_changednone全景场景点类型改变(室内景、室外景)时触发
PanoramaOptions
此类为Panorama类构造函数的可选参数,使用对象字面量形式表示,不可实例化。
属性
属性类型描述
navigationControlboolean是否显示全景的导航控件,默认为true
linksControlboolean是否显示道路指示控件。默认为true
indoorSceneSwitchControlboolean是否显示全景室内场景的切换控件,默认为false,仅对室内景生效
albumsControlboolean是否显示相册控件,默认为false
albumsControlOptionsAlbumsControlOptions全景相册控件配置参数
PanoramaLink
此类用来描述全景中道路指示中相邻全景的信息。使用对象字面量形式表示,不可实例化。
属性
属性类型描述
descriptionString相连全景的描述信息
headingNumber相连道路的方向,正北方向为0,正东为90,正南为180,正西为270
idString相邻全景的id
PanoramaPov
此类描述全景的视角。使用对象字面量形式表示,不可实例化。
属性
属性类型描述
headingNumber水平方向的角度,正北方向为0,正东为90,正南为180,正西为270
pitchNumber竖直方向的角度,向上最大到90度,向下最大到-90度。(在某些场景下,俯角可能无法到达最大值)
PanoramaService
此类用来检索全景数据信息。
构造函数
构造函数描述
PanoramaService()在创建检索全景数据信息类的实例
方法
方法返回值描述
getPanoramaById(id: String, callback: function, data: PanoramaData)none根据全景id返回全景数据,当获取不到数据时,回调函数参数为null
getPanoramaByLocation(point: Point, radius: number, callback: function, data: PanoramaData)none根据坐标及半径返回该范围内的全景数据;不设置半径参数时,默认半径为50米;当获取不到数据时,回调函数参数为null
PanoramaData
通过PanoramaService类检索获得。使用对象字面量形式表示,不可实例化。
属性
属性类型描述
idString全景id
descriptionString全景的描述信息
linksArray<PanoramaLink>全景相邻道路信息
positionPoint全景的地理坐标
tilesPanoramaTileData全景图块信息
PanoramaTileData
此类是图块数据信息,不可实例化。
属性
属性类型描述
centerHeadingNumber整个全景图中心位置的方位(单位角度)
tileSizeSize图块展示的尺寸(单位像素),注意这个尺寸与实际的图片尺寸可能不同
worldSizeSize整个全景图的尺寸(单位像素)
PanoramaLabel
该类提供在全景中添加标签功能。
构造函数
构造函数描述
PanoramaLabel(content: String, opts: PanoramaLabelOptions)构造函数,在全景中创建一个标签,content参数表示标签的文本内容,opts参数包含标签的经纬度坐标和高度
方法
方法返回值描述
setPosition(position: Point)none设置标签的经纬度坐标
getPosition()Point获取标签的经纬度坐标
getPov()PanoramaPov获取标签与全景中心点的视角
setContent(content: String)none设置标签显示内容
getContent()String获取标签的显示内容
show()none设置标签可见
hide()none设置标签不可见
setAltitude(altitude: Number)none设置标签距离地面的高度
getAltitude()Number获取标签距离地面的高度
addEventListener()none注册事件
removeEventListener()none移除事件
事件
事件参数描述
clicktype,target单击标签时触发该事件
mouseovertype,target鼠标移入标签时触发该事件
mouseouttype,target鼠标移出标签时触发该事件
removetype,target删除标签时触发该事件
PanoramaLabelOptions
此类为PanoramaLabel类构造函数的可选参数,使用对象字面量形式表示,不可实例化。
属性
属性类型描述
positionPoint文本标注的地理位置
altitudeNumber文本标注在全景场景点中距地面的高度。(javascript全景实现方式暂不支持),默认为2米
AlbumsControlOptions
此类为全景相册控件的可选参数,使用对象字面量形式表示,不可实例化。
属性
属性类型描述
anchorControlAnchor相册控件的停靠位置
offsetSize相册的偏移量
maxWidthNumber | String相册控件的最大宽度,可以设置总宽度百分比(例如50%) 或者像素数字(500),默认值为100%
imageHeightNumber相册内图片的高度。默认为80px。(为保证图片比例,只设置高度,宽度自如会拉宽)
PanoramaSceneType
常量区分室内场景和室外场景,其中室内景包括酒店内部、景区内部及高校内部等。
常量
常量描述
BMAP_PANORAMA_INDOOR_SCENE全景场景点的类型为室内场景
BMAP_PANORAMA_STREET_SCENE全景场景点的类型为室外场景
PanoramaPOIType
常量表示要在全景内显示的poi类型。
常量
常量描述
BMAP_PANORAMA_POI_HOTEL酒店类
BMAP_PANORAMA_POI_CATERING餐饮类
BMAP_PANORAMA_POI_MOVIE电影院
BMAP_PANORAMA_POI_TRANSIT公交站点
BMAP_PANORAMA_POI_INDOOR_SCENE室内景
BMAP_PANORAMA_POI_NONE无,即隐藏所有的poi类型