Extent~Extent

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

Позволяет пользователю нарисовать векторный прямоугольник, нажимая и перетаскивая указатель по карте. После создания прямоугольник можно изменить, перетаскивая его вершины или стороны. Взаимодействие также можно настроить, задав начальную область и createCondition, чтобы при желании предотвратить создание новой области при pointerdown.

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

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

Генерируемые события:

change (BaseEvent) — общее событие изменения. Вызывается при увеличении счетчика ревизий.
change:active (ObjectEvent)
error (BaseEvent) — общее событие ошибки. Вызывается при возникновении ошибки.
extentchanged (ExtentEvent) — вызывается после изменения области
propertychange (ObjectEvent) — вызывается при изменении свойства.

Наследует

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, строка 136

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

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

Возвращает:

Значение.

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

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

Возвращает:

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

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

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

Возвращает:

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

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

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

Устарел

Вместо него используйте getExtent.

Возвращает:

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

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

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

Возвращает:

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

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

Возвращает карту, связанную с этим взаимодействием.

Возвращает:

Карту.

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

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

Возвращает:

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

getProperties(){NoInfer.<Properties>} унаследовано Object.js, строка 158

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

Возвращает:

Объект.

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, строка 218

Задает значение.

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

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

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

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

setExtent(extent) interaction/Extent.js, строка 532

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

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

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

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

Имя	Тип	Описание
`values`	Partial.<NoInfer.<Properties>>	Значения.
`silent`	boolean \| undefined	Обновить без вызова события.

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

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

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

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

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

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