类:拖拽缩放

ol/interaction/DragZoom~拖拽缩放


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

允许用户通过点击并拖拽地图来缩放地图,通常与 ol/events/condition 结合使用,以将其限制为仅在按住键(默认为Shift键)时生效。

要更改框的样式,请使用CSS和.ol-dragzoom选择器,或使用由className配置的自定义选择器。

new DragZoom(options)

Name Type 描述
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函数。

触发事件:

继承

可观察属性

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

true若交互已激活,false否则。

方法

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

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

获取一个值。

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

更新而不触发事件。

启用或禁用交互。

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

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