MouseWheelZoom类

ol/interaction/MouseWheelZoom~鼠标滚轮缩放


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

用户可通过鼠标滚轮缩放地图。

new MouseWheelZoom(options)

Name Type 描述
condition Condition | undefined

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

onFocusOnly boolean (defaults to false)

当地图的目标有tabindex属性集设置时,交互仅在地图获得焦点时处理事件。

maxDelta number (defaults to 1)

最大鼠标滚轮增量。

duration number (defaults to 250)

动画持续时间(毫秒)。

timeout number (defaults to 80)

鼠标滚轮超时时长(毫秒)

useAnchor boolean (defaults to true)

启用以鼠标位置为锚点的缩放功能。当设置为false,缩放操作将以屏幕中心为基准进行,而非以鼠标位置为中心。

constrainResolution boolean (defaults to false)

若为 true,鼠标滚轮缩放将始终平滑过渡至最近的缩放级别;若为 false,则允许中间缩放级别。

触发事件:

继承

可观察属性

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

获取对象属性名称列表。

返回:
属性列表。

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

返回:
地图.

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

激活的。

setMouseAnchor(useAnchor)

启用或禁用缩放时以鼠标位置为锚点

Name Type 描述
useAnchor boolean

若为 true,则缩放至鼠标位置;若为 false,则缩放至地图中心。

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

清除设置且不触发事件。