Select~Select

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

Взаимодействие для выбора векторных объектов. По умолчанию выделенные объекты стилизуются по-другому, поэтому это взаимодействие можно использовать для визуального выделения, а также для выбора объектов для других действий, таких как модификация или вывод. Есть три способа управления тем, какие объекты выделены: использование события браузера, как определено в condition и необязательно toggle, add/remove и multi опции; layers фильтр; и дополнительный фильтр объектов с помощью опции filter.

new Select(options) interaction/Select.js, строка 159

Имя	Тип	Описание
`addCondition`	Condition \| undefined	Функция, которая принимает `MapBrowserEvent` и возвращает булево значение, указывающее, должно ли это событие обрабатываться. По умолчанию это `never`. Используйте это, если хотите использовать разные события для добавления и удаления вместо `toggle`.
`condition`	Condition \| undefined	Функция, которая принимает `MapBrowserEvent` и возвращает булево значение, указывающее, должно ли это событие обрабатываться. Это событие для выделенных объектов в целом. По умолчанию это `singleClick`. Щелчок по объекту выделяет этот объект и удаляет все, что было в выделении. Щелчок вне любого объекта удаляет все из выделения. См. опции `toggle`, `add`, `remove` для добавления/удаления дополнительных объектов в/из выделения.
`layers`	Array<Layer> \| function \| undefined	Список слоев, из которых следует выбирать объекты. В качестве альтернативы можно указать функцию-фильтр. Функция будет вызываться для каждого слоя в карте и должна возвращать `true` для слоев, которые вы хотите сделать выбираемыми. Если опция отсутствует, все видимые слои будут считаться выбираемыми.
`style`	StyleLike \| null \| undefined	Стиль для выделенных объектов. По умолчанию используется стиль редактирования по умолчанию (см. `Style`). Установите в `null`, если это взаимодействие не должно изменять стиль выделенных объектов. Если задано ложное значение, стиль выделенного объекта не изменится.
`removeCondition`	Condition \| undefined	Функция, которая принимает `MapBrowserEvent` и возвращает булево значение, указывающее, должно ли это событие обрабатываться. По умолчанию это `never`. Используйте это, если хотите использовать разные события для добавления и удаления вместо `toggle`.
`toggleCondition`	Condition \| undefined	Функция, которая принимает `MapBrowserEvent` и возвращает булево значение, указывающее, должно ли это событие обрабатываться. Это дополнительно к событию `condition`. По умолчанию `shiftKeyOnly`, то есть нажатие `shift` вместе с событием `condition`, добавляет этот объект к текущему выделению, если он не выбран, и удаляет его, если он выбран. См. `add` и `remove`, если вы хотите использовать другие события вместо переключения.
`multi`	boolean (defaults to false)	Булево значение, определяющее, должен ли по умолчанию выбираться только один объект или все (перекрывающиеся) объекты в позиции щелчка на карте. Значение по умолчанию `false` означает выбор одного объекта.
`features`	Collection<Feature> \| undefined	Коллекция, в которую взаимодействие поместит выбранные объекты. Необязательно. Если не задано, взаимодействие создаст коллекцию. В любом случае коллекция, используемая взаимодействием, возвращается методом `getFeatures`.
`filter`	FilterFunction \| undefined	Функция, которая принимает `Feature` и `Layer` и возвращает `true`, если объект может быть выбран, или `false` в противном случае.
`hitTolerance`	number (defaults to 0)	Допуск определения попадания. Пиксели внутри радиуса вокруг заданной позиции будут проверены на наличие объектов.

События:

change (BaseEvent) — Общее событие изменения. Срабатывает, когда увеличивается счетчик ревизий.
change:active (ObjectEvent)
error (BaseEvent) — Общее событие ошибки. Срабатывает при возникновении ошибки.
propertychange (ObjectEvent) — Срабатывает при изменении свойства.
select (SelectEvent) — Срабатывает, когда объект(ы) был(и) выбран(ы)/отмечен(ы) как невыбранный(ые).

Расширяет

Interaction

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

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

Методы

changed() унаследованный Observable.js, строка 68

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

dispatchEvent(event){boolean | undefined} унаследованный events/Target.js, строка 85

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

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

Возвращает:

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

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

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

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

Возвращает:

Значение.

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

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

Возвращает:

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

getFeatures(){Коллекция<Элемент>} interaction/Select.js, строка 296

Получить выбранные элементы.

Возвращает:

Коллекцию элементов.

getHitTolerance(){number} interaction/Select.js, строка 305

Возвращает порог обнаружения столкновения.

Возвращает:

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

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

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

Возвращает:

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

getLayer(feature){СлойВектора} interaction/Select.js, строка 316

Возвращает связанный vector layer выбранного элемента.

Имя	Тип	Описание
`feature`	Элемент	Элемент

Возвращает:

Слой.

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

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

Возвращает:

Карта.

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

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

Возвращает:

Объект.

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

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

Возвращает:

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

on(type, listener){КлючСобытия | Массив<КлючСобытия>} унаследованный Observable.js, строка 152

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

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

Возвращает:

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

once(type, listener){КлючСобытия | Массив<КлючСобытия>} унаследованный Observable.js, строка 164

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

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

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

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

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

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

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

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

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

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

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

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

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

setMap(карта) interaction/Select.js, строка 339

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

Имя	Тип	Описание
`map`	Карта \| null	Карта.

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

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

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

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

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

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

unset(ключ, негромко) унаследованное Object.js, строка 259

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

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