Extent~Extent

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

Позволяет пользователю рисовать прямоугольник, нажимая и перетаскивая на карте. После рисования прямоугольник можно изменить, перетаскивая его вершины или стороны. Эта интеракция поддерживается только для устройств с мышью.

new Extent(options) interaction/Extent.js, строка 99

Имя	Тип	Описание
`condition`	Condition \| undefined	Функция, принимающая `MapBrowserEvent` и возвращающая булево значение, указывающее, нужно ли обрабатывать событие. По умолчанию — `always`.
`extent`	Extent \| undefined	Начальный extent. По умолчанию extent отсутствует.
`boxStyle`	StyleLike \| undefined	Стиль для рисуемого прямоугольника. По умолчанию используется стиль редактирования `Polygon`, описанный в `Style`
`pixelTolerance`	number (по умолчанию 10)	Пиксельная толерантность для определения близости указателя к отрезку или вершине для редактирования.
`pointerStyle`	StyleLike \| undefined	Стиль курсора, используемого для рисования extent. По умолчанию используется стиль редактирования `Point`, описанный в `Style`
`wrapX`	boolean (по умолчанию false)	Обернуть отрисованный extent через несколько карт по оси X? Воздействие только на визуализацию, не на функциональность.

Вызывает:

change (BaseEvent) - Общее событие изменения. Срабатывает при увеличении счетчика ревизии.
change:active (ObjectEvent)
error (BaseEvent) - Общее событие об ошибке. Срабатывает при возникновении ошибки.
extentchanged (ExtentEvent) - Срабатывает после изменения extent
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 \| string	Объект события.

Возвращает:

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

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

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

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

Возвращает:

Значение.

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

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

Возвращает:

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

getExtent(){Extent} interaction/Extent.js, строка 450

Возвращает текущую область, нарисованную в проекции представления (или в пользовательской проекции, если она задана).

Возвращает:

Область, нарисованную в проекции представления.

getExtentInternal(){Extent} interaction/Extent.js, строка 463

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

Возвращает:

Область, нарисованную в проекции представления.

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

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

Возвращает:

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

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`	логическое	Активно.

setExtent(область) interaction/Extent.js, строка 473

Вручную устанавливает нарисованную область, используя проекцию представления.

Имя	Тип	Описание
`extent`	Область	Область

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

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

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

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

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

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

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

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

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