类:缩放到范围

ol/control/ZoomToExtent~缩放至范围


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

按钮控件,按下时可将地图视图调整至特定范围。要设置此控件的样式,请使用CSS选择器.ol-zoom-extent

new ZoomToExtent(options)

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

适配范围时传递给视图的选项(例如padding, duration, minResolution, maxZoom, easing, callback).

触发事件:

继承

方法

递增修订计数器并触发'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

在不触发事件的情况下取消设置。