Summary

Constructor

let compass = new hmap.control.Compass({
     position:"topleft",
     outColor: {
         background: "red",
         button: "blue"
     },
     innerColor: {
         background: "green",
         north: "blue",
         south: "white"
     }
});

Methods

activate()

激活控件。

Example

compass.activate();

deactivate()

禁用控件，禁用后不响应地图事件，不可互操作

Example

compass.deactivate();

destroy()

销毁控件，释放占用的内存。

Example

compass.destroy();

getControlType() → {String}

返回控件的类型

Returns:

String -

控件类型的名称

getId() → {String}

获取控件唯一标识

Returns:

String -

控件标识。

getMap() → {hmap.Map}

获取控件绑定的地图对象。

Returns:

hmap.Map -

地图对象。

getStatus() → {Boolean}

返回控件当前状态。

Returns:

Boolean -

true:表示激活 false:表示禁用。

setId(id)

设置控件唯一标识。如果唯一标识已经存在，则会返回添加失败异常。

Parameters:

Name	Type	Description
id	String	控件唯一标识。

updateStyle()

颜色样式更新

Parameters:

Name	Type	Description
options.position	String	控件位置，支持"topleft","topright"(默认),"bottomleft","bottomright"
options.outColor.background	String	外圈背景色
options.outColor.button	String	外圈按钮颜色
options.innerColor.background	String	内圈背景色
options.innerColor.north	String	内圈指北针颜色
options.innerColor.south	String	内圈指南针颜色

Example

compass.updateStyle({
     position:"topleft",
     outColor: {
         background: "red",
         button: "blue"
     },
     innerColor: {
         background: "green",
         north: "blue",
         south: "white"
     }
})