Class: Zoom

ol/control/Zoom~Zoom


import Zoom from 'ol/control/Zoom.js';

一个带有两个按钮的控件,一个用于放大,一个用于缩小。 此控件是地图的默认控件之一。要设置此控件的样式, 请使用 CSS 选择器 .ol-zoom-in.ol-zoom-out

new Zoom(options)

Name Type Description
duration number (defaults to 250)

动画持续时间,以毫秒为单位。

className string (defaults to 'ol-zoom')

CSS 类名。

zoomInClassName string (defaults to className + '-in')

放大按钮的 CSS 类名。

zoomOutClassName string (defaults to className + '-out')

缩小按钮的 CSS 类名。

zoomInLabel string | HTMLElement (defaults to '+')

放大按钮的文本标签。 除了文本,也可以使用元素(例如 span 元素)。

zoomOutLabel string | HTMLElement (defaults to '–')

缩小按钮的文本标签。 除了文本,也可以使用元素(例如 span 元素)。

zoomInTipLabel string (defaults to 'Zoom in')

用于按钮提示的文本标签。

zoomOutTipLabel string (defaults to 'Zoom out')

用于按钮提示的文本标签。

delta number (defaults to 1)

每次点击应用的缩放增量。

target HTMLElement | string | undefined

如果希望控件在地图视口之外渲染,请指定目标。

触发事件:

Extends

Methods

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type Description
event BaseEvent | string

事件对象。

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

获取一个值。

Name Type Description
key string

键名。

返回值:
值。

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

监听器函数。

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

渲染控件。

Name Type Description
mapEvent MapEvent

地图事件。

set(key, value, silent) inherited

设置一个值。

Name Type Description
key string

键名。

value *

值。

silent boolean | undefined

更新但不触发事件。

从当前地图移除控件并将其附加到新地图。 传入 null 仅从当前地图移除控件。 子类可以在此设置事件处理器以获取地图变更的通知。

Name Type Description
map Map | null

地图。

setProperties(values, silent) inherited

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

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

值。

silent boolean | undefined

更新但不触发事件。

此函数用于设置控件的目标元素。如果在控件添加到地图后调用则无效(即在控件上调用 setMap 之后)。如果在传递给控件构造函数的选项中未设置 target,且未调用 setTarget,则控件将被添加到地图的覆盖物容器中。

Name Type Description
target HTMLElement | string

目标。

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

取消设置但不触发事件。