Spec-Zone.ru › OpenLayers

ol/control/Zoom~Zoom


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

Контроль с 2 кнопками: одна для приближения, другая для удаления. Этот контроль является одним из стандартных контролей карты. Для стилизации этого контроля используйте CSS селекторы .ol-zoom-in и .ol-zoom-out.

new Zoom(options)

control/Zoom.js, line 34
Имя Тип Описание
duration число (по умолчанию 250)

Длительность анимации в миллисекундах.

className строка (по умолчанию 'ol-zoom')

Имя класса CSS.

zoomInClassName строка (по умолчанию className + '-in')

Имя класса CSS для кнопки приближения.

zoomOutClassName строка (по умолчанию className + '-out')

Имя класса CSS для кнопки удаления.

zoomInLabel строка | HTMLElement (по умолчанию '+')

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

zoomOutLabel строка | HTMLElement (по умолчанию '–')

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

zoomInTipLabel строка (по умолчанию 'Приблизить')

Текстовая метка для подсказки кнопки.

zoomOutTipLabel строка (по умолчанию 'Отдалить')

Текстовая метка для подсказки кнопки.

delta число (по умолчанию 1)

Зум-сдвиг, применяемый при каждом клике.

target HTMLElement | строка | undefined

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

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

Расширяет

  • Control

Методы

changed() inherited

Observable.js, line 68

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

Имя Тип Описание
event BaseEvent | string

Объект события.

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

get(key){*} inherited

Object.js, line 135

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

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

Имя ключа.

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

getKeys(){Array.<string>} inherited

Object.js, line 148

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

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

getMap(){Map | null} inherited

control/Control.js, line 104

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

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

getProperties(){Object.<string, *>} inherited

Object.js, line 157

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

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

getRevision(){number} inherited

Observable.js, line 79

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

Возвращает:
Номер ревизии.

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

Слушать события определённого типа.

Имя Тип Описание
type string | Array.<string>

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

listener function

Функция-обработчик.

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

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 164

Слушать событие определённого типа один раз.

Имя Тип Описание
type string | Array.<string>

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

listener function

Функция-обработчик.

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

render(mapEvent) inherited

control/Control.js, line 144

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

Имя Тип Описание
mapEvent MapEvent

Событие карты.

set(key, value, silent) inherited

Object.js, line 215

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

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

Имя ключа.

value *

Значение.

silent boolean | undefined

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

setMap(map) inherited

control/Control.js, line 116

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

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

Карта.

setProperties(values, silent) унаследованный

Object.js, строка 235

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

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

Значения.

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

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

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

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

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

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

Цель.

un(type, listener) унаследованный

Observable.js, строка 173

Отписаться от определенного типа события.

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

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

listener функция

Функция-обработчик.

unset(key, silent) унаследованный

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_Zoom-Zoom.html

Spec-Zone.ru

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