Class: Interaction

ol/interaction/Interaction~Interaction


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

抽象基类;通常仅用于创建子类,不在应用中直接实例化。 改变地图状态的用户操作。有些类似于控件, 但不与 DOM 元素关联。 例如,KeyboardZoom 在功能上 与 Zoom 相同,但由键盘事件而非按钮元素事件触发。 虽然交互没有 DOM 元素,但其中一些会渲染矢量,因此在屏幕上可见。

new Interaction(options)

Name Type Description
handleEvent function | undefined

由地图调用的方法,用于通知交互有浏览器事件被分发到地图。如果函数返回假值, 将阻止事件传播到地图交互链中的其他交互 (包括没有显式返回值的函数)。交互按地图交互集合的逆序遍历。

触发事件:

Subclasses

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

键名。

返回值:
值。

getActive(){boolean}

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

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

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回值:
属性名称列表。

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

返回值:
地图。

getProperties(){NoInfer.<Properties>} inherited

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

返回值:
对象。

getRevision(){number} inherited

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

返回值:
修订版本号。

handleEvent(mapBrowserEvent){boolean}

Name Type Description
mapBrowserEvent MapBrowserEvent

地图浏览器事件。

返回值:
false 以停止事件传播。

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

取消设置但不触发事件。