Class: ZoomToExtent

ol/control/ZoomToExtent~ZoomToExtent


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

一个按钮控件,按下时会将地图视图更改为特定的范围。要设置此控件的样式,请使用 CSS 选择器 .ol-zoom-extent

new ZoomToExtent(options)

Name Type Description
className string (defaults to 'ol-zoom-extent')

类名。

target HTMLElement | string | undefined

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

label string | HTMLElement (defaults to 'E')

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

tipLabel string (defaults to 'Fit to extent')

按钮提示的文本标签。

extent Extent | undefined

要缩放到的范围。如果未定义,则使用视图投影的有效范围。

fitOptions FitOptions | undefined

适配范围时传递给视图的选项 (如 paddingdurationminResolutionmaxZoomeasingcallback)。

触发事件:

Extends

Methods

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

dispatchEvent(event){boolean | undefined} inherited

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

Name Type Description
event BaseEvent | string

事件对象。

返回值:
false 如果有人在事件对象上调用了 preventDefault, 或者任何监听器返回了 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

取消设置但不触发事件。