类:键盘平移

ol/interaction/KeyboardPan~键盘平移


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

允许用户使用键盘方向键平移地图。请注意,尽管此交互功能默认包含在地图中,但仅当浏览器焦点位于键盘事件所附加的元素上时,才能使用这些按键。默认情况下,该元素为地图div,但您可以通过 Map 中的 keyboardEventTarget 进行更改。document 永远不会失去焦点;但对于任何其他元素,若要使按键生效,焦点必须始终位于该元素上,并在操作后返回到该元素。另请参阅 KeyboardZoom

new KeyboardPan(options)

Name Type 描述
condition Condition | undefined

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

duration number (defaults to 100)

动画时长(毫秒)

pixelDelta number (defaults to 128)

每次按键平移的像素数。

触发事件:

继承

可观察属性

Name Type 可设置 ObjectEvent type 描述
active boolean 是的 change:active

true如果交互已激活,false否则。

方法

递增修订计数器并触发“更改”事件。

dispatchEvent(event){boolean | undefined} inherited

分发一个事件,并调用所有侦听该类型事件的侦听器。事件参数可以是字符串,或者是一个具有 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象

返回:
false 如果有人在事件对象上调用了 preventDefault 方法,或者任何侦听器返回了 false。

获取值。

Name Type 描述
key string

键名

返回:
值。

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

返回:
交互激活时,为 true;否则为 false

getKeys(){Array.<string>} inherited

获取对象属性名称列表

返回:
属性名称列表

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

返回:
地图.

getProperties(){Object.<string, *>} inherited

获取包含所有属性及其值的对象。

返回:
对象。

getRevision(){number} inherited

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

返回:
修订。

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

监听特定事件类型。

Name Type 描述
type string | Array.<string>

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

listener function

监听器函数

返回:
监听器的唯一键。若以事件类型数组作为首个参数调用,则返回键的数组。

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

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

Name Type 描述
type string | Array.<string>

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

listener function

监听器函数

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

set(key, value, silent) inherited

设置一个值。

Name Type 描述
key string

键名。

value *

值。

silent boolean | undefined

在不触发事件的情况下更新。

启用或禁用交互。

Name Type 描述
active boolean

激活的。

setProperties(values, silent) inherited

设置键值对集合。注意:此操作将修改现有属性并添加新属性,但不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

更新时不触发事件。

un(type, listener) inherited

取消监听某种类型的事件。

Name Type 描述
type string | Array.<string>

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

listener function

监听器函数。

unset(key, silent) inherited

移除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

在不触发事件的情况下取消设置。