类:范围

ol/interaction/Extent~范围


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

允许用户通过在地图上单击并拖动来绘制矢量矩形。绘制完成后,可拖动其顶点或边进行修改。若需要,还可通过设置初始范围和 createCondition 来配置交互,以避免在 pointerdown 上生成新范围。

new Extent(options)

Name Type 描述
condition Condition | undefined

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

createCondition Condition | null (defaults to null)

一个函数接受一个MapBrowserEvent并返回一个布尔值,指示是否应处理该事件以创建新范围。如果null,这condition也将作为createCondition.

drag boolean (defaults to false)

范围可拖拽。

extent Extent | undefined

初始范围。默认为无。

boxStyle StyleLike | undefined

绘制范围框的样式默认为Polygon编辑样式记录于Style

pixelTolerance number (defaults to 10)

像素容差用于判定指针是否足够接近线段或顶点,以便进行编辑。

pointerStyle StyleLike | undefined

绘制范围的光标样式。默认为Point编辑样式记录在Style

wrapX boolean (defaults to false)

是否在X轴方向上跨多幅地图循环显示绘制范围?仅影响视觉效果,不影响功能。

触发事件:

继承

可观察属性

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

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

方法

递增修订计数器并触发'change'事件。

dispatchEvent(event){boolean | undefined} inherited

触发一个事件并调用所有监听该类型事件的侦听器。事件参数可以是字符串或具有 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果在事件对象上调用了 preventDefault,或者任何监听器返回了 false。

获取一个值。

Name Type 描述
key string

键名。

返回:
值。

返回交互当前是否激活。

返回:
如果交互处于激活状态,则 true;否则,false

获取视图投影下的当前绘制范围(若已设置用户投影则使用用户投影)

返回:
在视图投影中绘制的范围

getExtentInternal(){Extent}

返回视图投影下的当前绘制范围

已弃用
返回:
视图投影坐标系下的绘制范围。

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回:
属性列表

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

返回:
地图.

getPointerCount(){number} inherited

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

返回:
指针的数量。

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

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

返回:
对象。

getRevision(){number} inherited

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

返回:
修订。

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

激活的。

setExtent(extent)

通过视图投影手动设置绘制范围。

Name Type 描述
extent Extent

范围

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

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