control~Pan(options)

地图平移控件,激活后可以在地图上按住鼠标左键来拖动地图。

Summary

Methods:
activate

激活控件,map 添加控件会自动调用该方法,只有控件添加到地图上时才起作用。

deactivate

禁用控件 禁用地图的拖动操作。

destroy

销毁接口:销毁控件,释放占用的内存

getControlType

返回控件的类型

getId

获取控件唯一标识

getMap

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

getStatus

返回控件当前状态。

setId

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

Constructor

new Pan(options)

Parameters:
Name Type Description
options Object

可选参数

Name Type Description
disTolerance Number

距离容差,单位px, 默认8px。

Example
let map = new hmap.Map("hmap", {
        zoom: 12,
        center: new hmap.basetype.Coordinate(120.435078, 30.19345, 0),
        crs:new hmap.proj.Crs('4326'),//坐标系是地理可视化计算的基础,在地图对象初始化前务必指定
        minLevel:1,
        maxLevel:16
});
let pan = new hmap.control.Pan();

Methods

activate()

激活控件,map 添加控件会自动调用该方法,只有控件添加到地图上时才起作用。

Example
pan.activate();

deactivate()

禁用控件 禁用地图的拖动操作。

Example
pan.deactivate();

destroy()

销毁接口:销毁控件,释放占用的内存

Example
pan.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

控件唯一标识。