KeyboardPan~KeyboardPan

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

Позволяет пользователю перемещать карту с помощью стрелок клавиатуры. Обратите внимание, что, хотя эта интеракция по умолчанию включена в карты, клавиши можно использовать только при фокусе браузера на элементе, к которому прикреплены события клавиатуры. По умолчанию это div карты, но вы можете изменить это с помощью keyboardEventTarget в Map. document никогда не теряет фокус, но для любого другого элемента фокус должен быть на этом элементе и возвращаться к нему, если клавиши должны работать. См. также KeyboardZoom.

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

Имя	Тип	Описание
`condition`	Condition \| undefined	Функция, принимающая `MapBrowserEvent` и возвращающая boolean, указывающий, следует ли обрабатывать это событие. По умолчанию это `noModifierKeys` и `targetNotEditable`.
`duration`	number (defaults to 100)	Продолжительность анимации в миллисекундах.
`pixelDelta`	number (defaults to 128)	Количество пикселей для перемещения при каждом нажатии клавиши.

События:

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

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

Возвращает:

Карту.

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	Обновить без срабатывания события.

setActive(active) унаследованное interaction/Interaction.js, строка 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	Удалить без запуска события.