Pointer~PointerInteraction

import PointerInteraction from 'ol/interaction/Pointer.js';

Базовый класс, вызывающий пользовательские функции при событиях down, move и up. Этот класс также управляет "последовательностями перетаскивания".

Когда функция пользователя handleDownEvent возвращает true, запускается последовательность перетаскивания. Во время последовательности перетаскивания функция пользователя handleDragEvent вызывается для событий move. Последовательность перетаскивания завершается, когда функция пользователя handleUpEvent вызывается и возвращает false.

new PointerInteraction(options) interaction/Pointer.js, строка 45

Имя	Тип	Описание
`handleDownEvent`	функция \| undefined	Функция обработки событий "нажатия". Если функция возвращает `true`, то запускается последовательность перетаскивания.
`handleDragEvent`	функция \| undefined	Функция обработки событий "перетаскивания". Эта функция вызывается для событий "перемещения" во время последовательности перетаскивания.
`handleEvent`	функция \| undefined	Метод, вызываемый картой для уведомления взаимодействия о том, что событие браузера было отправлено на карту. Функция может вернуть `false`, чтобы предотвратить распространение события на другие взаимодействия в цепочке взаимодействий карты.
`handleMoveEvent`	функция \| undefined	Функция обработки событий "перемещения". Эта функция вызывается для событий "перемещения". Эта функция также вызывается во время последовательности перетаскивания, поэтому во время перетаскивания вызываются как функция `handleDragEvent`, так и эта функция. Если `handleDownEvent` определена и возвращает true, эта функция не будет вызываться во время последовательности перетаскивания.
`handleUpEvent`	функция \| undefined	Функция обработки событий "отпускания". Если функция возвращает `false`, то текущая последовательность перетаскивания останавливается.
`stopDown`	функция \| undefined	Должно ли событие "нажатия" быть передано другим взаимодействиям или оно должно быть остановлено?

Вызывает:

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

Подклассы

Расширяет

Interaction

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

Имя	Тип	Устанавливаемое	Тип 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 и может вызывать другие функции, если обнаруживаются последовательности событий, такие как, например, 'перетаскивание' или 'вниз-вверх' и т. д.

Имя	Тип	Описание
`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	Удалить без срабатывания события.