控件类
Control
此类是所有控件的基类，您可以通过此类来实现自定义控件。所有控件均包含Control类的属性、方法和事件。通过Map.addControl()方法可将控件添加到地图上。
构造函数 | 描述 |
Control() | 创建一个控件原型实例，通过该原型实例可创建自定义控件 |
属性 | 类型 | 描述 |
defaultAnchor | 控件默认的停靠位置。自定义控件时需要提供此属性，作为控件的默认停靠位置 | |
defaultOffset | 控件默认的位置偏移值。自定义控件时需要提供此属性，作为控件的默认偏移位置 |
方法 | 返回值 | 描述 |
initialize(map:Map) | HTMLElement | 抽象方法。调用Map.addControl()方法添加控件时将调用此方法，从而实现该控件的初始化。自定义控件时需要实现此方法，并将元素的DOM元素在该方法中返回。DOM元素需要添加到地图的容器中，使用map.getContainer()方法可获得地图容器元素 |
setAnchor(anchor:ControlAnchor) | none | 设置控件停靠的位置 |
getAnchor() | 返回控件停靠的位置 | |
setOffset(offset:Size) | none | 设置控件停靠的偏移量 |
getOffset() | 返回控件停靠的偏移量 | |
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() | 返回平移缩放控件的类型 | |
setType(type: NavigationControlType) | none | 设置平移缩放控件的类型 |
NavigationControlOptions
此类表示NavigationControl构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性 | 类型 | 描述 |
anchor | 控件的停靠位置 | |
offset | 控件的水平偏移值 | |
type | 平移缩放控件的类型 | |
showZoomInfo | Boolean | 是否显示级别提示信息 |
enableGeolocation | Boolean | 控件是否集成定位功能，默认为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() | 返回当前的定位信息。若当前还未定位，则返回null |
事件 | 参数 | 描述 |
locationSuccess | {point, AddressComponent} | 定位成功后触发此事件 |
locationError | {StatusCode} | 定位失败后触发此事件 |
GeolocationControlOptions
此类表示GeolocationControl构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性 | 类型 | 描述 |
anchor | 控件的停靠位置，默认定位到地图的右下角 | |
offset | 控件的水平偏移值 | |
showAddressBar | Boolean | 是否显示定位信息面板。默认显示定位信息面板 |
enableAutoLocation | Boolean | 添加控件时是否进行定位。默认添加控件时不进行定位 |
locationIcon | 可自定义定位中心点的Icon样式 |
OverviewMapControl
此类表示缩略地图控件。
构造函数 | 描述 |
OverviewMapControl(opts: OverviewMapControlOptions) | 创建一个缩略地图控件实例 |
方法 | 返回值 | 描述 |
changeView() | none | 切换缩略地图控件的开合状态 |
setSize(size: Size) | none | 设置缩略地图的大小 |
getSize() | 返回缩略地图的大小 |
事件 | 参数 | 描述 |
viewchanged | event{type, target, isOpen} | 缩略地图开合状态发生变化后触发此事件 |
viewchanging | event{type, target} | 缩略地图开合状态发生变化过程中触发此事件 |
OverviewMapControlOptions
此类表示OverviewMapControl构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性 | 类型 | 描述 |
anchor | 控件的停靠位置 | |
offset | 控件的偏移值 | |
size | 缩略地图控件的大小 | |
isOpen | Boolean | 缩略地图添加到地图后的开合状态，默认为关闭 |
ScaleControl
此类表示比例尺控件。
构造函数 | 描述 |
ScaleControl(opts: ScaleControlOptions) | 创建一个比例尺控件 |
方法 | 返回值 | 描述 |
getUnit() | 返回比例尺单位制 | |
setUnit(unit: LengthUnit) | none | 设置比例尺单位制 |
ScaleControlOptions
此类表示ScaleControl构造函数的可选参数。它没有构造函数，但可通过对象字面量形式表示。
属性 | 类型 | 描述 |
anchor | 控件的停靠位置 | |
offset | 控件的偏移值 |