Spec-Zone.ru › OpenLayers

ol/control/ZoomToExtent~ZoomToExtent


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

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

new ZoomToExtent(options)

control/ZoomToExtent.js, line 29
Имя Тип Описание
className string (по умолчанию 'ol-zoom-extent')

Имя класса.

target HTMLElement | string | undefined

Укажите целевой элемент, если вы хотите отобразить управление вне области просмотра карты.

label string | HTMLElement (по умолчанию 'E')

Текст метки для кнопки. Вместо текста также можно использовать элемент (например, элемент span).

tipLabel string (по умолчанию 'Fit to extent')

Текст подписи для кнопки.

extent Extent | undefined

Масштабируемый диапазон значений. Если неопределён, используется область видимости проекции представления.

Вызывает:
  • 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, строка 135

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

Имя Тип Описание
key string

Имя ключа.

Возвращает:
Значение.

getKeys(){Array.<string>} унаследованный

Object.js, строка 148

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

Возвращает:
Список имён свойств.

getMap(){Map | null} унаследованный

control/Control.js, строка 104

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

Возвращает:
Карту.

getProperties(){Object.<string, *>} унаследованный

Object.js, строка 157

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

Возвращает:
Объект.

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, строка 215

Устанавливает значение.

Имя Тип Описание
key string

Имя ключа.

value *

Значение.

silent boolean | undefined

Обновить без срабатывания события.

setMap(map) унаследованный

control/Control.js, строка 116

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

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

Карта.

setProperties(значения, беззвучно) унаследованный

Object.js, строка 235

Устанавливает коллекцию пар ключ-значение. Обратите внимание, что это изменяет все существующие свойства и добавляет новые (это не удаляет любые существующие свойства).

Имя Тип Описание
values Объект.<строка, *>

Значения.

silent логическое | undefined

Обновление без запуска события.

setTarget(цель) унаследованный

control/Control.js, строка 155

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

Имя Тип Описание
target Элемент HTML | строка

Цель.

un(тип, слушатель) унаследованный

Observable.js, строка 173

Отключить прослушивание определенного типа события.

Имя Тип Описание
type строка | Массив.<строка>

Тип события или массив типов событий.

listener функция

Функция-слушатель.

unset(ключ, беззвучно) унаследованный

Object.js, строка 259

Удалить свойство.

Имя Тип Описание
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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API