Class: MouseWheelZoom

ol/interaction/MouseWheelZoom~MouseWheelZoom


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

允许用户通过滚动鼠标滚轮来缩放地图。

new MouseWheelZoom(options)

Name Type Description
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 表示允许中间缩放级别。

触发事件:

Extends

Observable Properties

Name Type Settable ObjectEvent type Description
active boolean yes change:active

true 表示交互处于活动状态,否则为 false

Methods

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type Description
event BaseEvent | string

事件对象。

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

获取一个值。

Name Type Description
key string

键名。

返回值:
值。

返回交互当前是否激活。

返回值:
true 表示交互处于活动状态,否则为 false

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回值:
属性名列表。

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

返回值:
地图。

getProperties(){NoInfer.<Properties>} inherited

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

返回值:
对象。

getRevision(){number} inherited

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

返回值:
版本号。

on(type, listener){EventsKey | Array<EventsKey>} inherited

监听特定类型的事件。

Name Type Description
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

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

once(type, listener){EventsKey | Array<EventsKey>} inherited

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

Name Type Description
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

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

set(key, value, silent) inherited

设置一个值。

Name Type Description
key string

键名。

value *

值。

silent boolean | undefined

更新但不触发事件。

激活或停用交互。

Name Type Description
active boolean

是否激活。

setMouseAnchor(useAnchor)

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

Name Type Description
useAnchor boolean

true 表示缩放到鼠标位置,false 表示缩放到地图中心

setProperties(values, silent) inherited

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

Name Type Description
values Partial.<NoInfer.<Properties>>

值。

silent boolean | undefined

更新但不触发事件。

un(type, listener) inherited

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

Name Type Description
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

unset(key, silent) inherited

取消设置一个属性。

Name Type Description
key string

键名。

silent boolean | undefined

取消设置但不触发事件。