类:拖拽平移

ol/interaction/DragPan~拖拽平移


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

用户可通过拖拽地图进行平移。

new DragPan(options)

Name Type 描述
condition Condition | undefined

一个接收...的函数MapBrowserEvent并返回一个布尔值,表示是否应处理该事件。默认为noModifierKeysprimaryAction.

onFocusOnly boolean (defaults to false)

当地图容器具有tabindex若已设置属性集,则交互仅在地图获得焦点时处理事件。

kinetic Kinetic | undefined

应用于平移的动惯性。

触发事件:

继承

可观测属性

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

获取对象属性名称列表。

返回:
属性名称列表

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

返回:
地图.

getPointerCount(){number} inherited

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

返回:
指针数量。

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

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

返回:
对象。

getRevision(){number} inherited

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

返回:
修订。

handleEvent(mapBrowserEvent){boolean} inherited

处理 map browser event,并在检测到事件序列(如 'drag' 或 '按下-抬起' 等)时可能调用其他函数。

Name Type 描述
mapBrowserEvent MapBrowserEvent

地图浏览器事件。

返回:
false 用于停止事件传播。

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

取消设置而不触发事件。