ol/interaction/DragRotate~DragRotate
import DragRotate from 'ol/interaction/DragRotate.js';
Позволяет пользователю вращать карту, нажав и перетаскивая её, обычно в сочетании с ol/events/condition, ограничивающим вращение до одновременного нажатия клавиш Alt и Shift.
Эта функция взаимодействия поддерживается только для устройств с мышью.
-
new DragRotate(options)
-
Имя Тип Описание conditionCondition | undefined Функция, принимающая
MapBrowserEventи возвращающая логическое значение, определяющее, следует ли обрабатывать данное событие. По умолчанию используетсяaltShiftKeysOnly.durationnumber (defaults to 250) Длительность анимации в миллисекундах.
События:
-
change(BaseEvent) - Общее событие изменения. Срабатывает при увеличении счётчика пересмотра. -
change:active(ObjectEvent) -
error(BaseEvent) - Общее событие ошибки. Срабатывает при возникновении ошибки. -
propertychange(ObjectEvent) - Срабатывает при изменении свойства.
-
Расширяет
Наблюдаемые свойства
| Имя | Тип | Устанавливаемое | ObjectEvent тип | Описание |
|---|---|---|---|---|
active | boolean | да | change:active |
|
Методы
-
changed() унаследованный
-
Увеличивает счётчик ревизий и отправляет событие 'change'.
-
dispatchEvent(event){boolean | undefined} унаследованный
-
Отправляет событие и вызывает все обработчики, слушающие события этого типа. Параметр события может быть строкой или объектом с свойством
type.Имя Тип Описание eventBaseEvent | string Объект события.
Возвращает:
false, если кто-то вызвал preventDefault в объекте события или какой-либо из обработчиков вернул false.
-
get(key){*} унаследованный
-
Получает значение.
Имя Тип Описание keystring Имя ключа.
Возвращает:
Значение.
-
getActive(){boolean} унаследованный
-
Возвращает, активен ли взаимодействие в данный момент.
Возвращает:
true, если взаимодействие активно,falseв противном случае.
-
getKeys(){Array.<string>} унаследованный
-
Получает список имён свойств объекта.
Возвращает:
Список имён свойств.
-
getMap(){Map | null} унаследованный
-
Получает карту, связанную с этим взаимодействием.
Возвращает:
Карту.
-
getPointerCount(){number} унаследованный
-
Возвращает текущее количество указателей, участвующих во взаимодействии, например,
2, когда используется два пальца.Возвращает:
Количество указателей.
-
getProperties(){Object.<string, *>} унаследованный
-
Получает объект со всеми именами и значениями свойств.
Возвращает:
Объект.
-
getRevision(){number} унаследованный
-
Получает номер версии этого объекта. Каждый раз при изменении объекта его номер версии будет увеличен.
Возвращает:
Номер ревизии.
-
handleEvent(mapBrowserEvent){boolean} унаследованный
-
Обрабатывает
map browser eventи может вызывать другие функции, если обнаружены последовательности событий, такие как, например, 'drag' или 'down-up' и т.д.Имя Тип Описание mapBrowserEventMapBrowserEvent Событие браузера карты.
Возвращает:
false, чтобы остановить распространение события.
-
on(type, listener){EventsKey | Array<EventsKey>} унаследованный
-
Прослушивает определённый тип события.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ для обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращается массив ключей.
-
once(type, listener){EventsKey | Array<EventsKey>} унаследованный
-
Прослушать событие определенного типа один раз.
Имя Тип Описание typestring | Array.<string> Тип события или массив типов событий.
listenerfunction Функция-обработчик.
Возвращает:
Уникальный ключ для обработчика. Если вызван с массивом типов событий в качестве первого аргумента, возвращается массив ключей.
-
set(ключ, значение, без_события) унаследованный
-
Устанавливает значение.
Имя Тип Описание keyстрока Имя ключа.
value* Значение.
silentлогическое | undefined Обновление без срабатывания события.
-
setActive(активно) унаследованный
-
Активировать или деактивировать взаимодействие.
Имя Тип Описание activeлогическое Активно.
-
setProperties(значения, без_события) унаследованный
-
Устанавливает коллекцию пар ключ-значение. Обратите внимание, что это изменяет все существующие свойства и добавляет новые (это не удаляет никаких существующих свойств).
Имя Тип Описание valuesОбъект.<строка, *> Значения.
silentлогическое | undefined Обновление без срабатывания события.
-
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_interaction_DragRotate-DragRotate.html