类:翻译

ol/interaction/Translate~平移


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

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

new Translate(options)

Name Type 描述
condition Condition | undefined

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

features Collection<Feature> | undefined

该集合中的要素可以批量翻译。

layers Array<Layer> | function | undefined

应从中提取要素的图层列表。或者,可提供一个过滤函数。该函数将为地图中的每个图层调用,并应返回true针对您希望可翻译的图层,若未指定该选项,则所有可见图层均视为可翻译。该选项不适用如果。features已提供。

filter FilterFunction | undefined

一个接收Feature和一个Layer并返回true若要素可被变换或false否则,若不使用features已提供。

hitTolerance number (defaults to 0)

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

触发事件:

继承

可观测属性

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

getHitTolerance(){number}

返回拾取容差。

返回:
命中容差(以像素为单位)。

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回:
属性名称列表。

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

返回:
地图.

getPointerCount(){number} inherited

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

返回:
指针数量。

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

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

返回:
对象。

getRevision(){number} inherited

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

返回:
修订。

handleEvent(mapBrowserEvent){boolean} inherited

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

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

激活。

setHitTolerance(hitTolerance)

点击检测容差:将检查给定位置周围半径内的像素是否包含要素。

Name Type 描述
hitTolerance number

命中容差(像素)。

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

在不触发事件的情况下取消设置。