控件類
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 | 控件的偏移值 |