DragBox~DragBox

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

Позволяет пользователю рисовать прямоугольник на карте, перетаскивая мышкой, обычно в сочетании с ol/events/condition, который ограничивает рисование, например, удерживанием клавиши Shift или другой клавиши. Это используется, например, для масштабирования до определённой области карты (см. DragZoom и DragRotateAndZoom).

new DragBox(options) interaction/DragBox.js, строка 118

Имя	Тип	Описание
`className`	string (по умолчанию 'ol-dragbox')	Имя CSS-класса для стилизации прямоугольника.
`condition`	Condition \| undefined	Функция, принимающая `MapBrowserEvent` и возвращающая boolean, указывающий, нужно ли обрабатывать событие. По умолчанию `ol/events/condition~mouseActionButton`.
`minArea`	number (по умолчанию 64)	Минимальная площадь прямоугольника в пикселях; это значение используется функцией по умолчанию `boxEndCondition`.
`boxEndCondition`	EndCondition \| undefined	Функция, принимающая `MapBrowserEvent` и два `Pixel`, чтобы указать, должно ли срабатывать событие `boxend`. По умолчанию `true`, если площадь прямоугольника больше, чем опция `minArea`.
`onBoxEnd`	function \| undefined	Код, который выполняется непосредственно перед тем, как срабатывает `boxend`.

Вызывает:

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

Подклассы

DragZoom

Расширяет

PointerInteraction

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

Имя	Тип	Устанавливаемое	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 в противном случае.

getGeometry(){Polygon} interaction/DragBox.js, строка 198

Возвращает геометрию последнего нарисованного прямоугольника.

Возвращает:

Геометрию.

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

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

Возвращает:

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

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

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

Возвращает:

Карту.

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

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

Возвращает:

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

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

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

Возвращает:

Объект.

getRevision(){number} унаследованный Observable.js, строка 79

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

Возвращает:

Ревизию.

handleEvent(mapBrowserEvent){boolean} унаследованный interaction/Pointer.js, строка 125

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

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

Возвращает:

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

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

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

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

setActive(активно) interaction/DragBox.js, строка 292

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

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

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

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

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

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

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

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

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

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

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