类:缩放

ol/control/Zoom~缩放


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

一个包含放大和缩小两个按钮的控件。该控件是地图的默认控件之一。如需自定义此控件样式,请使用 CSS 选择器 .ol-zoom-in.ol-zoom-out

new Zoom(options)

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

若要将控件渲染在地图视口之外,请指定目标。

触发事件:

继承

方法

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果事件对象上调用了 preventDefault 方法,或任何监听器返回了 false。

获取一个值。

Name Type 描述
key string

键名。

返回:
值。

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

监听器函数

返回:
监听器的唯一键。若以事件类型数组作为第一个参数调用,则返回键的数组。

渲染控件。

Name Type 描述
mapEvent MapEvent

地图事件。

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名。

value *

值。

silent boolean | undefined

更新而不触发事件。

将控件从当前地图移除并附加到新地图。传入 null 以仅从当前地图中删除控件。子类可以在此处设置事件处理程序以接收地图更改的通知。

Name Type 描述
map Map | null

地图.

setProperties(values, silent) inherited

设置键值对集合。请注意,此操作将修改现有属性并添加新属性,且不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

在不触发事件的情况下更新

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

Name Type 描述
target HTMLElement | string

目标。

un(type, listener) inherited

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

Name Type 描述
type string | Array.<string>

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

listener function

监听器函数。

unset(key, silent) inherited

移除属性。

Name Type 描述
key string

键名称。

silent boolean | undefined

取消设置而不触发事件。