类:键盘缩放

ol/interaction/KeyboardZoom~键盘缩放


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

允许用户使用键盘上的“+”和“-”键缩放地图。注意,尽管该交互默认已包含在地图中,但仅在浏览器焦点位于键盘事件绑定的元素上时,这些按键才有效。默认情况下,该元素为地图的`div`容器,但您可以通过`Map`中定义的`keyboardEventTarget`进行修改。`document`始终保留焦点;而对于任何其他元素,若要使按键生效,焦点必须持续作用于该元素。另请参阅`KeyboardPan`。

new KeyboardZoom(options)

Name Type 描述
duration number (defaults to 100)

动画时长(毫秒)

condition Condition | undefined

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

delta number (defaults to 1)

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

触发事件:

继承

可观察属性

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

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

方法

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

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

取消设置且不触发事件。