Class: KeyboardZoom

ol/interaction/KeyboardZoom~KeyboardZoom


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

允许用户使用键盘 + 和 - 缩放地图。 请注意,虽然此交互默认包含在地图中,但只有当浏览器焦点位于键盘事件附加的元素上时,按键才能使用。默认情况下,这是地图的 div 元素,不过您可以通过 Map 中的 keyboardEventTarget 来更改此设置。document 永远不会失去焦点,但对于任何其他元素,如果要使按键功能正常,焦点必须位于该元素上并返回到该元素。 另请参阅 KeyboardPan

new KeyboardZoom(options)

Name Type Description
duration number (defaults to 100)

动画持续时间,以毫秒为单位。

condition Condition | undefined

接受 MapBrowserEvent 并返回布尔值以指示是否应处理该事件的函数。默认条件是满足 targetNotEditable 且未按下平台修饰键(!platformModifierKey)。

delta number (defaults to 1)

每次按键的缩放级别增量。

触发事件:

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

事件对象。

返回值:
如果有人在事件对象上调用了 preventDefault 或任何监听器返回 false,则返回 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

取消设置但不触发事件。