DragPan~DragPan

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

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

new DragPan(options) interaction/DragPan.js, line 35

Имя	Тип	Описание
`condition`	Condition \| undefined	Функция, которая принимает `MapBrowserEvent` и возвращает булево значение, указывающее, должно ли это событие обрабатываться. По умолчанию — `noModifierKeys` и `primaryAction`.
`onFocusOnly`	boolean (defaults to false)	Если у целевого элемента карты установлено свойство `tabindex`, взаимодействие будет обрабатывать события только при фокусе карты.
`kinetic`	Kinetic \| undefined	Кинетическая инерция, применяемая к перемещению.

Вызывает:

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

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

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

Возвращаемое значение:

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

get(key){*} унаследованно Object.js, строка 135

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

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

Возвращаемое значение:

Значение.

getActive(){boolean} унаследованно interaction/Interaction.js, строка 82

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

Возвращаемое значение:

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

getKeys(){Array.<string>} унаследованно Object.js, строка 148

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

Возвращаемое значение:

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

getMap(){Карта | null} унаследованно interaction/Interaction.js, строка 91

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

Возвращаемое значение:

Карта.

getPointerCount(){число} унаследованно interaction/Pointer.js, строка 95

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

Возвращаемое значение:

Количество указателей.

getProperties(){Object.<string, *>} унаследованно Object.js, строка 157

Возвращает объект со всеми именами и значениями свойств.

Возвращаемое значение:

Объект.

getRevision(){число} унаследованно 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`	строка \| Array.<строка>	Тип события или массив типов событий.
`listener`	функция	Функция-слушатель.

Возвращаемое значение:

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

once(type, listener){EventsKey | Array<EventsKey>} унаследованно Observable.js, строка 164

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

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

Возвращаемое значение:

set(key, value, silent) унаследованный Object.js, строка 215

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

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

setActive(active) унаследованный interaction/Interaction.js, строка 111

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

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

setProperties(values, silent) унаследованный Object.js, строка 235

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

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

un(type, listener) унаследованный Observable.js, строка 173

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

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

unset(key, silent) унаследованный Object.js, строка 259

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

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