KeyboardRoam
查阅Leaflet API

new mars2d.thing.KeyboardRoam(options)
thing/KeyboardRoam.js 20

键盘漫游功能

参数名称 类型 描述信息
options Object 可选

参数对象，包括以下

参数名称 类型 默认值 描述信息
id String | Number createGuid() 可选

对象的id标识
enabled Boolean true 可选

对象的启用状态
moveStep number 10 可选

步长（米）
eventParent BaseClass | Boolean 可选

指定的事件冒泡对象，默认为所加入的map对象，false时不冒泡事件
参考:

继承自

属性值

enabled : boolean
thing/KeyboardRoam.js 45

是否启用

id : String|Number
core/BaseThing.js 63

对象的id标识

继承自:

只读 isAdded : Boolean
core/BaseThing.js 55

是否已添加到地图

继承自:

moveStep : number
thing/KeyboardRoam.js 57

步幅

只读 options : Object
core/BaseClass.js 18

当前类的构造参数

继承自:

只读 state : State
core/BaseThing.js 44

当前对象的状态

继承自:

方法

abstract _mountedHook() → void
core/BaseThing.js 187

对象添加到地图前创建一些对象的钩子方法， 只会调用一次

返回值:

无

继承自:

addEventParent(obj) → BaseClass
core/BaseClass.js 294

添加抛出事件到父类，它将接收传播的事件

参数名称 类型 描述信息
obj Object

父类对象
返回值:

当前对象本身,可以链式调用

继承自:

addTo(map) → BaseThing
core/BaseThing.js 95

添加到地图上，同 map.addThing

参数名称 类型 描述信息
map Map

地图对象
返回值:

当前对象本身，可以链式调用

继承自:

destroy(noDel) → void
core/BaseClass.js 33

销毁当前对象

参数名称 类型 默认值 描述信息
noDel Boolean false 可选

false:会自动delete释放所有属性，true：不delete绑定的变量
返回值:

无

继承自:

fire(type, data, propagate) → BaseClass
core/BaseClass.js 199

触发指定类型的事件。

参数名称 类型 默认值 描述信息
type EventType | String

事件类型
data Object 可选

传输的数据或对象，可在事件回调方法中event对象中获取进行使用
propagate BaseClass | Object null 可选

将事件传播给父类 (用addEventParent设置)
返回值:

当前对象本身,可以链式调用

继承自:

hasEventParent(obj) → BaseClass
core/BaseClass.js 321

是否绑定了抛出事件到指定父类

参数名称 类型 描述信息
obj Object

父类对象
返回值:

当前对象本身,可以链式调用

继承自:

listens(type, propagate) → Boolean
core/BaseClass.js 244

是否有绑定指定的事件

参数名称 类型 描述信息
type EventType | String

事件类型
propagate Object 可选

是否判断指定的父类 (用addEventParent设置的)
返回值:

是否存在

继承自:

off(types, fn, context) → BaseClass
core/BaseClass.js 90

解除绑定指定类型事件监听器

参数名称 类型 描述信息
types EventType | String | Array.<EventType> 可选

事件类型,未传值时解绑所有事件
fn function 可选

绑定的监听器回调方法,未传值时解绑所有指定类型对应事件
context Object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

当前对象本身,可以链式调用

继承自:

on(types, fn, context) → BaseClass
core/BaseClass.js 52

绑定指定类型事件监听器, 支持在监听中调用 event.stopPropagation(); 组织事件冒泡

参数名称 类型 描述信息
types EventType | String | Array.<EventType>

事件类型
fn function 可选

绑定的监听器回调方法
context Object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

当前对象本身,可以链式调用

继承自:

once(types, fn, context) → BaseClass
core/BaseClass.js 271

绑定一次性执行的指定类型事件监听器 与on类似，监听器只会被触发一次，然后被删除。

参数名称 类型 描述信息
types EventType | String | Array.<EventType>

事件类型
fn function 可选

绑定的监听器回调方法
context Object 可选

侦听器的上下文(this关键字将指向的对象)。
返回值:

当前对象本身,可以链式调用

继承自:

remove(destroy) → void
core/BaseThing.js 108

从地图上移除，同map.removeThing

参数名称 类型 描述信息
destroy Boolean 可选

是否调用destroy释放
返回值:

无

继承自:

removeEventParent(obj) → BaseClass
core/BaseClass.js 307

移除抛出事件到父类

参数名称 类型 描述信息
obj Object

父类对象
返回值:

当前对象本身,可以链式调用

继承自:

setOptions(options, funOptions) → BaseThing|object
thing/KeyboardRoam.js 156

更新参数

参数名称 类型 描述信息
options object

与类的构造方法参数相同
funOptions Object 可选

方法参数，包括以下

参数名称 类型 默认值 描述信息
merge boolean true 可选

是否合并参数, 如是完整覆盖不合并老的options，请传入fasle
返回值:

当前对象本身，可以链式调用

定义的类型

mars2d.thing.KeyboardRoam.EventType
thing/KeyboardRoam.js 4

当前类支持的EventType事件类型

属性:
属性名称 类型 描述信息
keydown String

左键单击 鼠标事件
keyup String

完成加载，执行所有内部处理后
使用示例:
//绑定监听事件
layer.on(mars2d.EventType.load, function (event) {
  console.log('矢量数据对象加载完成', event)
})
参考:
下载离线API文档