Class: Translate

ol/interaction/Translate~Translate


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

用于平移(移动)要素的交互。 如果要在单个操作中平移多个要素(例如,选择交互使用的集合),请使用 features 选项构造交互。

new Translate(options)

Name Type Description
condition Condition | undefined

接受 MapBrowserEvent 并返回布尔值以指示是否应处理该事件的函数。默认为 always

features Collection<要素> | undefined

此集合中包含的要素可以一起平移。

layers Array<Layer> | function | undefined

应从中平移要素的图层列表。或者,可以提供过滤函数。该函数将为地图中的每个图层调用,对于希望可平移的图层应返回 true。如果未提供此选项,所有可见图层将被视为可平移。如果提供了 features 则不使用此选项。

filter Filter函数 | undefined

接受 要素Layer 的函数,如果要素可以被平移则返回 true,否则返回 false。如果提供了 features 则不使用此选项。

hitTolerance number (defaults to 0)

命中检测容差。给定位置半径内的像素将被检查是否包含要素。

触发事件:

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

getHitTolerance(){number}

返回the Hit-detection tolerance.

返回值:
命中容差(像素)。

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回值:
属性名列表。

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

返回值:
地图。

getPointerCount(){number} inherited

返回当前参与交互的指针数量,例如使用两根手指时为 2。

返回值:
The number of pointers.

getProperties(){NoInfer.<Properties>} inherited

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

返回值:
对象。

getRevision(){number} inherited

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

返回值:
版本号。

handleEvent(mapBrowserEvent){boolean} inherited

处理 地图浏览器事件,如果检测到如 'drag' 或 'down-up' 等事件序列,可能会调用其他函数。

Name Type Description
mapBrowserEvent MapBrowserEvent

地图浏览器事件。

返回值:
false to stop event propagation.

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

是否激活。

setHitTolerance(hitTolerance)

命中检测容差。给定位置半径内的像素将被检查是否包含要素。

Name Type Description
hitTolerance number

命中容差(像素)。

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

取消设置但不触发事件。