ol/control/ZoomToExtent~ZoomToExtent
import ZoomToExtent from 'ol/control/ZoomToExtent.js';
Кнопка управления, которая при нажатии изменяет представление карты на определённый масштаб. Для стилизации этой кнопки используйте CSS-селектор .ol-zoom-extent.
-
new ZoomToExtent(options)
-
Имя Тип Описание classNamestring (по умолчанию 'ol-zoom-extent') Имя класса.
targetHTMLElement | string | undefined Укажите целевой элемент, если вы хотите отобразить управление вне области просмотра карты.
labelstring | HTMLElement (по умолчанию 'E') Текст метки для кнопки. Вместо текста также можно использовать элемент (например, элемент
span).tipLabelstring (по умолчанию 'Fit to extent') Текст подписи для кнопки.
extentExtent | undefined Масштабируемый диапазон значений. Если неопределён, используется область видимости проекции представления.
Вызывает:
-
change(BaseEvent) — Общее событие изменения. Срабатывает при увеличении счётчика ревизий. -
error(BaseEvent) — Общее событие об ошибке. Срабатывает при возникновении ошибки. -
propertychange(ObjectEvent) — Срабатывает при изменении свойства.
-
Расширяет
Методы
-
changed() унаследованный
-
Увеличивает счётчик изменений и отправляет событие 'change'.
-
dispatchEvent(event){boolean | undefined} унаследованный
-
Отправляет событие и вызывает все обработчики, слушающие события этого типа. Параметр event может быть строкой или объектом с свойством
type.Имя Тип Описание eventBaseEvent | string Объект события.
Возвращает:
false, если кто-то вызвал preventDefault в объекте события или какой-либо из обработчиков вернул false.
-
get(key){*} унаследованный
-
Получает значение.
Имя Тип Описание keystring Имя ключа.
Возвращает:
Значение.
-
getKeys(){Array.<string>} унаследованный
-
Получает список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getMap(){Map | null} унаследованный
-
Получает карту, связанную с этим элементом управления.
Возвращает:
Карту.
-
getProperties(){Object.<string, *>} унаследованный
-
Получает объект со всеми именами и значениями свойств.
Возвращает:
Объект.
-
getRevision(){number} унаследованный
-
Получает номер версии этого объекта. Каждый раз при изменении объекта его номер версии увеличивается.
Возвращает:
Номер версии.
-
on(type, listener){EventsKey | Array<EventsKey>} унаследованный
-
Привязывается к определённому типу события.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ для обработчика. Если используется массив типов событий, возвращается массив ключей.
-
once(type, listener){EventsKey | Array<EventsKey>} унаследованный
-
Привязывается к определённому типу события один раз.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ для обработчика. Если используется массив типов событий, возвращается массив ключей.
-
render(mapEvent) унаследованный
-
Отображает элемент управления.
Имя Тип Описание mapEventMapEvent Событие карты.
-
set(key, value, silent) унаследованный
-
Устанавливает значение.
Имя Тип Описание keystring Имя ключа.
value* Значение.
silentboolean | undefined Обновить без срабатывания события.
-
setMap(map) унаследованный
-
Удалить элемент управления из текущей карты и прикрепить его к новой карте. Передайте
null, чтобы просто удалить элемент управления из текущей карты. Подклассы могут настроить обработчики событий, чтобы получать уведомления о изменениях на карте.Имя Тип Описание mapКарта | null Карта.
-
setProperties(значения, беззвучно) унаследованный
-
Устанавливает коллекцию пар ключ-значение. Обратите внимание, что это изменяет все существующие свойства и добавляет новые (это не удаляет любые существующие свойства).
Имя Тип Описание valuesОбъект.<строка, *> Значения.
silentлогическое | undefined Обновление без запуска события.
-
setTarget(цель) унаследованный
-
Эта функция используется для установки целевого элемента для элемента управления. Она не имеет эффекта, если вызывается после добавления элемента управления на карту (т.е. после вызова
setMapна элементе управления). Еслиtargetне задан в параметрах, переданных конструктору элемента управления, и еслиsetTargetне вызывается, то элемент управления добавляется в контейнер наложения карты.Имя Тип Описание targetЭлемент HTML | строка Цель.
-
un(тип, слушатель) унаследованный
-
Отключить прослушивание определенного типа события.
Имя Тип Описание typeстрока | Массив.<строка> Тип события или массив типов событий.
listenerфункция Функция-слушатель.
-
unset(ключ, беззвучно) унаследованный
-
Удалить свойство.
Имя Тип Описание keyстрока Имя ключа.
silentлогическое | undefined Удалить без запуска события.
© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_control_ZoomToExtent-ZoomToExtent.html