OpenLayers v10.9.0 API - Class: DragZoom

new DragZoom(options) interaction/Drag缩放。js, line 32

Name	Type	Description
`className`	string (defaults to 'ol-dragzoom')	用于样式化方框的 CSS 类名。
`condition`	Condition \| undefined	一个接受`MapBrowserEvent`并返回布尔值以指示是否应处理该事件的函数。默认为`shiftKeyOnly`。
`duration`	number (defaults to 200)	动画持续时间，以毫秒为单位。
`out`	boolean (defaults to false)	使用此交互进行缩小操作。
`minArea`	number (defaults to 64)	方框的最小面积（像素），此值由父级默认的 `boxEndCondition` 函数使用。

触发事件：

boxcancel (DragBoxEvent) - 拖拽框取消时触发。
boxdrag (DragBoxEvent) - 框处于活动状态时拖动触发。
boxend (DragBoxEvent) - 拖拽框结束时触发。
boxstart (DragBoxEvent) - 拖拽框开始时触发。
change (BaseEvent) - 通用更改事件。当修订计数器增加时触发。
change:active (ObjectEvent)
error (BaseEvent) - 通用错误事件。当发生错误时触发。
propertychange (ObjectEvent) - 当属性更改时触发。

Extends

DragBox

Observable Properties

Name	Type	Settable	ObjectEvent type	Description
`active`	boolean	yes	`change:active`	如果交互处于激活状态则为 `true`，否则为 `false`。

Methods

changed() inherited Observable.js, line 68

增加修订计数器并分发 'change' 事件。

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

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

Name	Type	Description
`event`	BaseEvent \| string	事件对象。

返回值：

如果有人在事件对象上调用了 preventDefault 或任何监听器返回 false，则返回 false。

get(key){*} inherited Object.js, line 136

获取一个值。

Name	Type	Description
`key`	string	键名。

返回值：

值。

getActive(){boolean} inherited interaction/Interaction.js, line 82

返回交互当前是否激活。

返回值：

如果交互处于激活状态则为 true，否则为 false。

getGeometry(){Polygon} inherited interaction/DragBox.js, line 198

返回最后绘制的矩形的几何对象。

返回值：

几何对象。

getKeys(){Array.<string>} inherited Object.js, line 149

获取对象属性名列表。

返回值：

属性名列表。

getMap(){Map | null} inherited interaction/Interaction.js, line 91

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

返回值：

地图。

getPointerCount(){number} inherited interaction/Pointer.js, line 95

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

返回值：

指针数量。

getProperties(){NoInfer.<Properties>} inherited Object.js, line 158

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

返回值：

对象。

getRevision(){number} inherited Observable.js, line 79

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

返回值：

版本号。

handleEvent(mapBrowserEvent){boolean} inherited interaction/Pointer.js, line 125

处理地图浏览器事件，如果检测到如"拖拽"或"按下-抬起"等事件序列，可能会调用其他函数。

Name	Type	Description
`mapBrowserEvent`	MapBrowserEvent	地图浏览器事件。

返回值：

false 以停止事件传播。

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

监听特定类型的事件。

Name	Type	Description
`type`	string \| Array.<string>	事件类型或事件类型数组。
`listener`	function	监听器函数。

返回值：

监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

仅监听一次特定类型的事件。

Name	Type	Description
`type`	string \| Array.<string>	事件类型或事件类型数组。
`listener`	function	监听器函数。

返回值：

监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

set(key, value, silent) inherited Object.js, line 218

设置一个值。

Name	Type	Description
`key`	string	键名。
`value`	*	值。
`silent`	boolean \| undefined	更新但不触发事件。

setActive(active) inherited interaction/DragBox.js, line 292

激活或停用交互。

Name	Type	Description
`active`	boolean	是否激活。

setProperties(values, silent) inherited Object.js, line 238

设置一组键值对。注意，这会更改任何现有属性并添加新属性（不会移除任何现有属性）。

Name	Type	Description
`values`	Partial.<NoInfer.<Properties>>	值。
`silent`	boolean \| undefined	更新但不触发事件。

un(type, listener) inherited Observable.js, line 173

取消监听特定类型的事件。

Name	Type	Description
`type`	string \| Array.<string>	事件类型或事件类型数组。
`listener`	function	监听器函数。

unset(key, silent) inherited Object.js, line 262

取消设置一个属性。

Name	Type	Description
`key`	string	键名。
`silent`	boolean \| undefined	取消设置但不触发事件。