Class: KeyboardPan

ol/interaction/KeyboardPan~KeyboardPan


import KeyboardPan from 'ol/interaction/KeyboardPan.js';

允许用户使用键盘方向键平移地图。 请注意,尽管此交互默认包含在地图中, 但按键只能在浏览器焦点位于键盘事件所附加的元素上时使用。默认情况下,这是地图 div, 不过你可以通过 Map 中的 keyboardEventTarget 更改此设置。document 永远不会失去焦点,但对于任何其他元素, 如果按键要起作用,焦点必须在此元素上并返回到此元素。 另请参见 KeyboardZoom

new KeyboardPan(options)

Name Type Description
condition Condition | undefined

一个函数,接受 MapBrowserEvent 并返回一个 布尔值以指示是否应处理该事件。默认为 noModifierKeystargetNotEditable

duration number (defaults to 100)

动画持续时间(毫秒)。

pixelDelta number (defaults to 128)

每次按键平移的像素量。

触发事件:

Extends

Observable Properties

Name Type Settable ObjectEvent type Description
active boolean yes change:active

true 如果交互处于活动状态,否则为 false

Methods

增加修订计数器并分发 'change' 事件。

dispatchEvent(event){boolean | undefined} inherited

分发事件并调用所有监听此类型事件的监听器。 事件参数可以是字符串或带有 type 属性的对象。

Name Type Description
event BaseEvent | string

事件对象。

返回值:
false 如果有人对事件对象调用了 preventDefault,或任何监听器返回 false。

获取一个值。

Name Type Description
key string

键名。

返回值:
值。

返回交互当前是否处于活动状态。

返回值:
true 如果交互处于活动状态,否则为 false

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回值:
属性名称列表。

获取与此交互关联的地图。

返回值:
地图。

getProperties(){NoInfer.<Properties>} inherited

获取所有属性名称和值的对象。

返回值:
对象。

getRevision(){number} inherited

获取此对象的版本号。每次修改对象时,其版本号将递增。

返回值:
修订版本号。

on(type, listener){EventsKey | Array<EventsKey>} inherited

监听特定类型的事件。

Name Type Description
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

返回值:
监听器的唯一键。如果 以事件类型数组作为第一个参数调用,返回值 将是键数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited

监听一次特定类型的事件。

Name Type Description
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

返回值:
监听器的唯一键。如果 以事件类型数组作为第一个参数调用,返回值 将是键数组。

set(key, value, silent) inherited

设置一个值。

Name Type Description
key string

键名。

value *

值。

silent boolean | undefined

更新但不触发事件。

激活或停用交互。

Name Type Description
active boolean

活动状态。

setProperties(values, silent) inherited

设置一组键值对。注意,这会更改现有属性并添加新属性(不会移除任何现有属性)。

Name Type Description
values Partial.<NoInfer.<Properties>>

值。

silent boolean | undefined

更新但不触发事件。

un(type, listener) inherited

取消监听特定类型的事件。

Name Type Description
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

unset(key, silent) inherited

取消设置一个属性。

Name Type Description
key string

键名。

silent boolean | undefined

取消设置但不触发事件。