Spec-Zone.ru › OpenLayers

ol/control/Rotate~Rotate


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

Кнопка для сброса вращения до 0. Для стилизации этой кнопки используйте CSS-селектор .ol-rotate. CSS-селектор .ol-hidden добавляется к кнопке, когда вращение равно 0.

new Rotate(options)

control/Rotate.js, строка 34
Имя Тип Описание
className string (по умолчанию 'ol-rotate')

Имя класса CSS.

label string | HTMLElement (по умолчанию '⇧')

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

tipLabel string (по умолчанию 'Reset rotation')

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

compassClassName string (по умолчанию 'ol-compass')

Имя класса CSS для компаса.

duration number (по умолчанию 250)

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

autoHide boolean (по умолчанию true)

Скрыть элемент управления, когда вращение равно 0.

render function | undefined

Функция, вызываемая, когда элемент управления должен быть перерисован. Она вызывается в коллбеке requestAnimationFrame.

resetNorth function | undefined

Функция, вызываемая при нажатии на элемент управления. Это переопределяет стандартное resetNorth.

target HTMLElement | string | undefined

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

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

Расширяет

  • Control

Методы

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

Имя ключа.

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

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

Object.js, строка 148

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

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

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

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

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

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

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

Object.js, строка 157

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

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

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

Observable.js, строка 79

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

Возвращает:
Ревизия.

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(key, value, silent) унаследованный

Object.js, строка 215

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

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

Имя ключа.

value *

Значение.

silent boolean | undefined

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

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

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

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

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

Карта.

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

Object.js, строка 235

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

Имя Тип Описание
values Object.<string, *>

Значения.

silent boolean | undefined

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

setTarget(target) inherited

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

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

Имя Тип Описание
target HTMLElement | string

Целевой элемент.

un(type, listener) inherited

Observable.js, строка 173

Отключение прослушивания определенного типа события.

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

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

listener function

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

unset(key, silent) inherited

Object.js, строка 259

Удаляет свойство.

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

Имя ключа.

silent boolean | undefined

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

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_control_Rotate-Rotate.html

Spec-Zone.ru

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