Interaction~Interaction

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

Абстрактный базовый класс; обычно используется только для создания подклассов и не создается в приложениях. Действия пользователя, которые изменяют состояние карты. Некоторые похожи на элементы управления, но не связаны с элементом DOM. Например, KeyboardZoom функционально идентичен Zoom, но срабатывает при нажатии клавиши, а не нажатии кнопки. Хотя у взаимодействий нет элемента DOM, некоторые из них отображают векторы и поэтому видны на экране.

new Interaction(options) interaction/Interaction.js, строка 41

Имя	Тип	Описание
`handleEvent`	функция \| undefined	Метод, вызываемый картой для уведомления взаимодействия о том, что событие браузера было отправлено на карту. Если функция возвращает ложное значение, распространение события на другие взаимодействия в цепочке взаимодействий карты будет предотвращено (включая функции без явного возврата). Взаимодействия обрабатываются в обратном порядке коллекции взаимодействий карты.

Вызывает:

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

Подклассы

Расширяет

BaseObject

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

Имя	Тип	Устанавливаемое	ObjectEvent тип	Описание
`active`	boolean	да	`change:active`	`true`, если взаимодействие активно, `false` в противном случае.

Методы

changed() inherited Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} inherited events/Target.js, строка 85

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

Имя	Тип	Описание
`event`	BaseEvent \| string	Объект события.

Возвращает:

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

get(key){*} inherited Object.js, строка 135

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

Имя	Тип	Описание
`key`	string	Имя ключа.

Возвращает:

Значение.

getActive(){boolean} interaction/Interaction.js, строка 82

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

Возвращает:

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

getKeys(){Array.<string>} inherited Object.js, строка 148

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

Возвращает:

Список имён свойств.

getMap(){Map | null} interaction/Interaction.js, строка 91

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

Возвращает:

Карту.

getProperties(){Object.<string, *>} inherited Object.js, строка 157

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

Возвращает:

Объект.

getRevision(){number} inherited Observable.js, строка 79

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

Возвращает:

Номер ревизии.

handleEvent(mapBrowserEvent){boolean} interaction/Interaction.js, строка 101

Обрабатывает событие map browser event.

Имя	Тип	Описание
`mapBrowserEvent`	MapBrowserEvent	Событие браузера карты.

Возвращает:

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

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, строка 152

Прислушиваться к определённому типу события.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция обработчика.

Возвращает:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, строка 164

Прислушиваться один раз к определённому типу события.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция обработчика.

Возвращает:

set(key, value, silent) inherited Object.js, строка 215

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

Имя	Тип	Описание
`key`	string	Имя ключа.
`value`	*	Значение.
`silent`	boolean \| undefined	Обновить без запуска события.

setActive(active) interaction/Interaction.js, line 111

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

Имя	Тип	Описание
`active`	boolean	Активно.

setProperties(values, silent) inherited Object.js, line 235

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

Имя	Тип	Описание
`values`	Object.<string, *>	Значения.
`silent`	boolean \| undefined	Обновить без срабатывания события.

un(type, listener) inherited Observable.js, line 173

Отписаться от определенного типа события.

Имя	Тип	Описание
`type`	string \| Array.<string>	Тип события или массив типов событий.
`listener`	function	Функция-обработчик.

unset(key, silent) inherited Object.js, line 259

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

Имя	Тип	Описание
`key`	string	Имя ключа.
`silent`	boolean \| undefined	Удалить без срабатывания события.