Spec-Zone.ru › OpenLayers

ol/interaction/KeyboardZoom~KeyboardZoom


import KeyboardZoom from 'ol/interaction/KeyboardZoom.js';

Позволяет пользователю изменять масштаб карты с помощью клавиш + и -. Обратите внимание, что, хотя эта интеракция по умолчанию включена в карты, клавиши можно использовать только при фокусе браузера на элементе, к которому привязаны события клавиатуры. По умолчанию это div карты, но вы можете изменить это с помощью keyboardEventTarget в Map. document никогда не теряет фокус, но для любого другого элемента фокус должен быть на нём и вернуться к нему, если клавиши должны работать. См. также KeyboardPan.

new KeyboardZoom(options)

interaction/KeyboardZoom.js, line 33
Имя Тип Описание
duration число (по умолчанию 100)

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

condition Condition | undefined

Функция, принимающая MapBrowserEvent и возвращающая boolean, указывающий, должно ли это событие обрабатываться. По умолчанию условие состоит в том, что targetNotEditable выполняется и что модификаторная клавиша платформы не нажата (!platformModifierKey).

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

Изменение уровня масштаба при каждом нажатии клавиши.

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

Расширяет

  • Interaction

Наблюдаемые свойства

Имя Тип Устанавливаемое ObjectEvent тип Описание
active boolean да change:active

true, если интеракция активна, false в противном случае.

Методы

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

Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} унаследованный

events/Target.js, строка 85

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

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

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

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

get(key){*} унаследованный

Object.js, строка 135

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

Имя Тип Описание
key строка

Имя ключа.

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

getActive(){boolean} унаследованный

interaction/Interaction.js, строка 82

Возвращает, активен ли взаимодействие в данный момент.

Возвращает:
true, если взаимодействие активно, false в противном случае.

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

Object.js, строка 148

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

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

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

interaction/Interaction.js, строка 91

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

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

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

Object.js, строка 157

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

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

getRevision(){number} унаследованный

Observable.js, строка 79

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

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

on(type, listener){EventsKey | Array<EventsKey>} унаследованный

Observable.js, строка 152

Подписаться на определённый тип события.

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

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

listener функция

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

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

once(type, listener){EventsKey | Array<EventsKey>} унаследованный

Observable.js, строка 164

Подписаться на определённый тип события один раз.

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

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

listener функция

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

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

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

Object.js, строка 215

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

Имя Тип Описание
key строка

Имя ключа.

value *

Значение.

silent boolean | undefined

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

setActive(active) унаследованный

interaction/Interaction.js, строка 111

Активировать или деактивировать взаимодействие.

Имя Тип Описание
active boolean

Активно.

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

Object.js, строка 235

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

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

Значения.

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

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

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_interaction_KeyboardZoom-KeyboardZoom.html

Spec-Zone.ru

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