ZoomToExtent~ZoomToExtent

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

Элемент управления в виде кнопки, при нажатии на которую вид карты изменяется так, чтобы отобразить заданную область. Для стилизации этого элемента управления используйте CSS-селектор .ol-zoom-extent.

new ZoomToExtent(options) control/ZoomToExtent.js, строка 31

Имя	Тип	Описание
`className`	string (по умолчанию 'ol-zoom-extent')	Имя класса.
`target`	HTMLElement \| string \| undefined	Укажите целевой элемент, если нужно отобразить элемент управления за пределами области просмотра карты.
`label`	string \| HTMLElement (по умолчанию 'E')	Текстовая подпись на кнопке. Вместо текста также можно использовать элемент (например, элемент `span`).
`tipLabel`	string (по умолчанию 'Fit to extent')	Текстовая подпись для подсказки кнопки.
`extent`	Extent \| undefined	Область, к которой нужно выполнить масштабирование. Если значение не задано, используется область допустимых значений проекции вида.
`fitOptions`	FitOptions \| undefined	Параметры, передаваемые виду при подгонке области (например, `padding`, `duration`, `minResolution`, `maxZoom`, `easing`, `callback`).

События:

change (BaseEvent) — общее событие изменения. Вызывается при увеличении счётчика ревизии.
error (BaseEvent) — общее событие ошибки. Вызывается при возникновении ошибки.
propertychange (ObjectEvent) — вызывается при изменении свойства.

Наследует

Control

Методы

changed() унаследовано Observable.js, строка 68

Увеличивает счётчик ревизии и отправляет событие 'change'.

dispatchEvent(event){boolean | undefined} унаследовано events/Target.js, строка 85

Отправляет событие и вызывает все обработчики, ожидающие события этого типа. Параметр event может быть строкой или объектом со свойством type.

Имя	Тип	Описание
`event`	BaseEvent \| string	Объект события.

Возвращает:

false, если кто-либо вызвал preventDefault для объекта события или если любой из обработчиков вернул false.

get(key){*} унаследовано Object.js, строка 136

Получает значение.

Имя	Тип	Описание
`key`	string	Имя ключа.

Возвращает:

Значение.

getKeys(){Array.<string>} унаследовано Object.js, строка 149

Получает список имён свойств объекта.

Возвращает:

Список имён свойств.

getMap(){Map | null} унаследовано control/Control.js, строка 104

Получает карту, связанную с этим элементом управления.

Возвращает:

Карта.

getProperties(){NoInfer.<Properties>} унаследовано Object.js, строка 158

Получает объект со всеми именами свойств и их значениями.

Возвращает:

Объект.

getRevision(){number} унаследовано Observable.js, строка 79

Получает номер версии этого объекта. При каждом изменении объекта номер его версии увеличивается.

Возвращает:

Ревизия.

on(type, listener){EventsKey | Array<EventsKey>} унаследовано Observable.js, строка 152

Ожидает событие указанного типа.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

Возвращает:

Уникальный ключ обработчика. Если первый аргумент — массив типов событий, возвращается массив ключей.

once(type, listener){EventsKey | Array<EventsKey>} унаследовано Observable.js, строка 164

Однократно ожидает событие указанного типа.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

Возвращает:

Уникальный ключ обработчика. Если первый аргумент — массив типов событий, возвращается массив ключей.

render(mapEvent) унаследовано control/Control.js, строка 144

Отображает элемент управления.

Имя	Тип	Описание
`mapEvent`	MapEvent	Событие карты.

set(key, value, silent) унаследовано Object.js, строка 218

Задаёт значение.

Имя	Тип	Описание
`key`	string	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновить без вызова события.

setMap(map) унаследовано control/Control.js, строка 116

Удаляет элемент управления с текущей карты и добавляет его на новую. Передайте null, чтобы просто удалить элемент управления с текущей карты. Здесь подклассы могут настраивать обработчики событий для уведомления об изменениях карты.

Имя	Тип	Описание
`map`	Map \| null	Карта.

setProperties(values, silent) унаследовано Object.js, строка 238

Задаёт набор пар «ключ-значение». Обратите внимание: при этом изменяются существующие свойства и добавляются новые (существующие свойства не удаляются).

Имя	Тип	Описание
`values`	Partial.<NoInfer.<Properties>>	Значения.
`silent`	boolean \| undefined	Обновить без вызова события.

setTarget(target) унаследовано control/Control.js, строка 155

Эта функция задаёт целевой элемент для элемента управления. Вызов не оказывает эффекта, если элемент управления уже добавлен на карту (то есть после вызова setMap для элемента управления). Если в параметрах, переданных конструктору элемента управления, не задано target и не вызывается setTarget, элемент управления добавляется в контейнер наложений карты.

Имя	Тип	Описание
`target`	HTMLElement \| string	Целевой элемент.

un(type, listener) унаследовано Observable.js, строка 173

Прекращает ожидание события указанного типа.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

unset(key, silent) унаследовано Object.js, строка 262

Сбрасывает свойство.

Имя	Тип	Описание
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Сбросить без вызова события.