类:DragBox

ol/interaction/DragBox~拖拽框


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

允许用户通过在地图上单击并拖动来绘制矢量矩形,通常与 ol/events/condition 结合使用,以限制仅在按住 Shift 或其他键时触发。例如,用于缩放到地图的特定区域(请参阅 DragZoomDragRotateAndZoom)。

new DragBox(options)

Name Type 描述
className string (defaults to 'ol-dragbox')

框样式的CSS类名。

condition Condition | undefined

接收参数的函数MapBrowserEvent返回一个布尔值以指示该事件是否应被处理。默认为ol/events/condition~mouseActionButton.

minArea number (defaults to 64)

盒子在像素中的最小面积,该值由默认设置使用。boxEndCondition函数。

boxEndCondition EndCondition | undefined

一个接受一个参数的函数MapBrowserEvent以及两个Pixels 用于指示是否 aboxend事件应被触发。默认为。true如果边界框的面积大于minArea配置项。

onBoxEnd function | undefined

前置代码boxend已触发

触发事件:

子类

继承

可观测属性

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,若检测到事件序列(如“拖动”或“按下-抬起”等),则可能调用其他函数。

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

在不触发事件的情况下更新

setActive(active)

激活或禁用交互。

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

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