Spec-Zone.ru › OpenLayers

ol/interaction/DragRotate~DragRotate


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

Позволяет пользователю вращать карту, нажав и перетаскивая её, обычно в сочетании с ol/events/condition, ограничивающим вращение до одновременного нажатия клавиш Alt и Shift.

Эта функция взаимодействия поддерживается только для устройств с мышью.

new DragRotate(options)

interaction/DragRotate.js, line 31
Имя Тип Описание
condition Condition | undefined

Функция, принимающая MapBrowserEvent и возвращающая логическое значение, определяющее, следует ли обрабатывать данное событие. По умолчанию используется altShiftKeysOnly.

duration number (defaults to 250)

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

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

Расширяет

  • PointerInteraction

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

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

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

Методы

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

Observable.js, строка 68

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

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

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

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

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

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

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

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

Object.js, строка 135

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

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

Имя ключа.

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

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

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

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

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

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

Object.js, строка 148

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

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

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

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

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

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

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

interaction/Pointer.js, строка 95

Возвращает текущее количество указателей, участвующих во взаимодействии, например, 2, когда используется два пальца.

Возвращает:
Количество указателей.

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

Object.js, строка 157

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

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

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

Observable.js, строка 79

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

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

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

interaction/Pointer.js, строка 125

Обрабатывает map browser event и может вызывать другие функции, если обнаружены последовательности событий, такие как, например, 'drag' или 'down-up' и т.д.

Имя Тип Описание
mapBrowserEvent MapBrowserEvent

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

Возвращает:
false, чтобы остановить распространение события.

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

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

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

set(ключ, значение, без_события) унаследованный

Object.js, строка 215

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

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

Имя ключа.

value *

Значение.

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

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

setActive(активно) унаследованный

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

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

Имя Тип Описание
active логическое

Активно.

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

Object.js, строка 235

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

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

Значения.

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

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

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_interaction_DragRotate-DragRotate.html

Spec-Zone.ru

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