ol/interaction/KeyboardZoom~KeyboardZoom
import KeyboardZoom from 'ol/interaction/KeyboardZoom.js';
Позволяет пользователю изменять масштаб карты с помощью клавиш + и -. Обратите внимание, что, хотя эта интеракция по умолчанию включена в карты, клавиши можно использовать только при фокусе браузера на элементе, к которому привязаны события клавиатуры. По умолчанию это div карты, но вы можете изменить это с помощью keyboardEventTarget в Map. document никогда не теряет фокус, но для любого другого элемента фокус должен быть на нём и вернуться к нему, если клавиши должны работать. См. также KeyboardPan.
-
new KeyboardZoom(options)
-
Имя Тип Описание durationчисло (по умолчанию 100) Длительность анимации в миллисекундах.
conditionCondition | undefined Функция, принимающая
MapBrowserEventи возвращающая boolean, указывающий, должно ли это событие обрабатываться. По умолчанию условие состоит в том, чтоtargetNotEditableвыполняется и что модификаторная клавиша платформы не нажата (!platformModifierKey).deltaчисло (по умолчанию 1) Изменение уровня масштаба при каждом нажатии клавиши.
Вызывает:
-
change(BaseEvent) - Общее событие изменения. Срабатывает, когда счётчик ревизий увеличивается. -
change:active(ObjectEvent) -
error(BaseEvent) - Общее событие ошибки. Срабатывает при возникновении ошибки. -
propertychange(ObjectEvent) - Срабатывает при изменении свойства.
-
Расширяет
Наблюдаемые свойства
| Имя | Тип | Устанавливаемое | ObjectEvent тип | Описание |
|---|---|---|---|---|
active | boolean | да | change:active |
|
Методы
-
changed() унаследованный
-
Увеличивает счётчик ревизий и отправляет событие 'change'.
-
dispatchEvent(event){boolean | undefined} унаследованный
-
Отправляет событие и вызывает всех слушателей, ожидающих события данного типа. Параметр события может быть либо строкой, либо объектом с свойством
type.Имя Тип Описание eventBaseEvent | строка Объект события.
Возвращает:
false, если кто-то вызвал preventDefault для объекта события или если любой из слушателей вернул false.
-
get(key){*} унаследованный
-
Получает значение.
Имя Тип Описание keyстрока Имя ключа.
Возвращает:
Значение.
-
getActive(){boolean} унаследованный
-
Возвращает, активен ли взаимодействие в данный момент.
Возвращает:
true, если взаимодействие активно,falseв противном случае.
-
getKeys(){Array.<string>} унаследованный
-
Получить список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getMap(){Map | null} унаследованный
-
Получить карту, связанную с этим взаимодействием.
Возвращает:
Карту.
-
getProperties(){Object.<string, *>} унаследованный
-
Получить объект со всеми именами свойств и их значениями.
Возвращает:
Объект.
-
getRevision(){number} унаследованный
-
Получить номер версии для данного объекта. Каждый раз, когда объект изменяется, его номер версии увеличивается.
Возвращает:
Номер ревизии.
-
on(type, listener){EventsKey | Array<EventsKey>} унаследованный
-
Подписаться на определённый тип события.
Имя Тип Описание typeстрока | Array.<строка> Тип события или массив типов событий.
listenerфункция Функция-слушатель.
Возвращает:
Уникальный ключ для слушателя. Если вызвана с массивом типов событий в качестве первого аргумента, возвращается массив ключей.
-
once(type, listener){EventsKey | Array<EventsKey>} унаследованный
-
Подписаться на определённый тип события один раз.
Имя Тип Описание typeстрока | Array.<строка> Тип события или массив типов событий.
listenerфункция Функция-слушатель.
Возвращает:
Уникальный ключ для слушателя. Если вызвана с массивом типов событий в качестве первого аргумента, возвращается массив ключей.
-
set(key, value, silent) унаследованный
-
Устанавливает значение.
Имя Тип Описание keyстрока Имя ключа.
value* Значение.
silentboolean | undefined Обновить без запуска события.
-
setActive(active) унаследованный
-
Активировать или деактивировать взаимодействие.
Имя Тип Описание activeboolean Активно.
-
setProperties(values, silent) унаследованно
-
Устанавливает набор пар ключ-значение. Обратите внимание, что это изменяет все существующие свойства и добавляет новые (не удаляет существующие свойства).
Имя Тип Описание valuesОбъект.<строка, *> Значения.
silentлогическое | undefined Обновление без срабатывания события.
-
un(type, listener) унаследованно
-
Отключение прослушивания определенного типа события.
Имя Тип Описание typeстрока | Массив.<строка> Тип события или массив типов событий.
listenerфункция Функция-обработчик.
-
unset(key, silent) унаследованно
-
Удаляет свойство.
Имя Тип Описание 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