Translate~Перемещение

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

Интерактивный элемент для перемещения (сдвига) объектов. Если вы хотите перемещать несколько объектов в одном действии (например, коллекцию, используемую взаимодействием выбора), создайте взаимодействие с опцией features.

new Translate(options) interaction/Translate.js, строка 134

Имя	Тип	Описание
`condition`	Condition \| undefined	Функция, принимающая событие `MapBrowserEvent` и возвращающая булево значение, указывающее, нужно ли обрабатывать это событие. По умолчанию - `always`.
`features`	Коллекция<Объект> \| undefined	Объекты, содержащиеся в этой коллекции, будут перемещаться вместе.
`layers`	Массив<Слой> \| функция \| undefined	Список слоёв, объекты с которых должны быть перемещены. В качестве альтернативы можно указать функцию-фильтр. Функция будет вызвана для каждого слоя на карте и должна вернуть `true` для слоёв, которые должны быть перемещаемыми. Если опция отсутствует, все видимые слои будут считаться перемещаемыми. Не используется, если предоставлен параметр `features`.
`filter`	ФункцияФильтрации \| undefined	Функция, которая принимает `Feature` и `Layer` и возвращает `true`, если объект может быть перемещён, или `false` в противном случае. Не используется, если предоставлен параметр `features`.
`hitTolerance`	число (по умолчанию 0)	Толерантность к обнаружению объектов. Пиксели внутри радиуса вокруг заданной позиции будут проверены на наличие объектов.

Возбуждает события:

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

Расширяет

PointerInteraction

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

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

Методы

changed() inherited Observable.js, line 68

Увеличивает счётчик ревизии и отправляет событие «изменение».

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

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

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

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

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

get(key){*} inherited Object.js, line 135

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

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

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

Значение.

getActive(){boolean} inherited interaction/Interaction.js, line 82

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

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

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

getHitTolerance(){number} interaction/Translate.js, line 388

Возвращает погрешность обнаружения попадания.

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

Погрешность обнаружения попадания в пикселях.

getKeys(){Array.<string>} inherited Object.js, line 148

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

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

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

getMap(){Map | null} inherited interaction/Interaction.js, line 91

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

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

Карта.

getPointerCount(){number} inherited interaction/Pointer.js, line 95

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

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

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

getProperties(){Object.<string, *>} inherited Object.js, line 157

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

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

Объект.

getRevision(){number} inherited Observable.js, line 79

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

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

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

handleEvent(mapBrowserEvent){boolean} inherited interaction/Pointer.js, line 125

Обрабатывает map browser event и может вызывать другие функции, если обнаружены последовательности событий, такие как, например, «перетаскивание» или «нажатие-отпускание» и т. д.

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

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

false для остановки распространения события.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

Прослушивание событий определённого типа.

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

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

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

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

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

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

Результат:

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

set(ключ, значение, без звука) унаследованный Object.js, строка 215

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

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

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

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

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

setHitTolerance(толерантность_к_попаданию) interaction/Translate.js, строка 398

Допуск для определения попадания. Пиксели внутри радиуса вокруг заданной позиции будут проверяться на наличие объектов.

Имя	Тип	Описание
`hitTolerance`	число	Допуск к попаданию в пикселях.

setProperties(значения, без звука) унаследованный Object.js, строка 235

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

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

un(тип, обработчик) унаследованный Observable.js, строка 173

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

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

unset(ключ, без звука) унаследованный Object.js, строка 259

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

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