类：指针交互

ol/interaction/Pointer~指针交互


import PointerInteraction from 'ol/interaction/Pointer.js';

一个基类，它在 down、move 和 up 事件上调用用户自定义函数，并管理“拖拽序列”。

当 handleDownEvent 用户函数返回 true 时，即启动拖动序列。在拖动序列期间，针对 move 事件调用 handleDragEvent 用户函数。当调用 handleUpEvent 用户函数并返回 false 时，拖动序列结束。

new PointerInteraction(options)

interaction/Pointer.js, line 45
Name Type 描述
handleDownEvent function | undefined

处理按下事件的函数。如果该函数返回true随后启动拖拽序列。
handleDragEvent function | undefined

处理“拖动”事件的函数。在拖动序列期间，当“移动”事件发生时调用此函数。
handleEvent function | undefined

由地图调用的方法，用于通知交互对象浏览器事件已分派到地图。该函数可能返回。false以防止事件传播到地图交互链中的其他交互。
handleMoveEvent function | undefined

用于处理移动事件的函数。该函数在移动事件触发时及拖动序列期间均会被调用。因此，在拖动序列期间，handleDragEvent函数与该函数均会被触发。若handleDownEvent函数已定义且返回 True，则在拖动序列期间不会调用该函数。
handleUpEvent function | undefined

处理“up”事件的函数。如果该函数返回false然后停止当前的拖拽序列。
stopDown function | undefined

按下事件是否应传播到其他交互，还是应被阻止？
触发事件：

子类

继承

可观察属性

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

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

方法

changed() inherited

Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

Name Type 描述
event BaseEvent | string

事件对象。
返回：
false 如果事件对象上调用了 preventDefault 或任何侦听器返回了 false。

get(key){*} inherited

Object.js, line 135

获取值。

Name Type 描述
key string

键名。
返回：
值。

getActive(){boolean} inherited

interaction/Interaction.js, line 82

返回交互当前是否激活。

返回：
若交互激活，则对应 true；否则对应 false。

getKeys(){Array.<string>} inherited

Object.js, line 148

获取对象属性名称列表。

返回：
属性名称列表。

getMap(){Map | null} inherited

interaction/Interaction.js, line 91

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

返回：
地图.

getPointerCount(){number}

interaction/Pointer.js, line 95

返回当前交互中涉及的指针数量，例如使用两个手指时，2。

返回：
指针数量。

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

Object.js, line 157

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

返回：
对象。

getRevision(){number} inherited

Observable.js, line 79

获取该对象的版本号；每次对象被修改时，其版本号将自动递增。

返回：
修订。

handleEvent(mapBrowserEvent){boolean}

interaction/Pointer.js, line 125

处理 map browser event，并在检测到如“拖拽”或“按下-释放”等事件序列时，可能调用其他函数。

Name Type 描述
mapBrowserEvent MapBrowserEvent

地图浏览器事件。
返回：
false 停止事件传播。

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

Observable.js, line 152

监听特定类型的事件。

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

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

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

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

Observable.js, line 164

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

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

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

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

set(key, value, silent) inherited

Object.js, line 215

设置值。

Name Type 描述
key string

键名
value *

值。
silent boolean | undefined

更新而不触发事件。

setActive(active) inherited

interaction/Interaction.js, line 111

启用或禁用交互。

Name Type 描述
active boolean

激活的。

setProperties(values, silent) inherited

Object.js, line 235

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

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

值。
silent boolean | undefined

更新时不触发事件。

un(type, listener) inherited

Observable.js, line 173

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

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

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

监听器函数。

unset(key, silent) inherited

Object.js, line 259

清除属性。

Name Type 描述
key string

键名。
silent boolean | undefined

取消设置而不触发事件。