ol/Collection~Collection

import Collection from 'ol/Collection.js';

Расширенная версия стандартного массива JS с дополнительными удобными методами для работы с ним. Добавление и удаление элементов вызывает событие Collection. Обратите внимание: это не относится к изменениям объектов внутри Collection; они вызывают события для соответствующего объекта, а не для Collection в целом.

new Collection(array, options) Collection.js, строка 76

Имя Тип Описание

array

Array.<T> | undefined

Массив.

options

Параметры Collection.

Имя	Тип	Описание
`unique`	boolean (по умолчанию false)	Запретить добавление одного и того же элемента в коллекцию несколько раз.

Вызывает события:

add (CollectionEvent) — возникает при добавлении элемента в коллекцию.
change (BaseEvent) — общее событие изменения. Возникает при увеличении счётчика ревизии.
change:length (ObjectEvent)
error (BaseEvent) — общее событие ошибки. Возникает при возникновении ошибки.
propertychange (ObjectEvent) — возникает при изменении свойства.
remove (CollectionEvent) — возникает при удалении элемента из коллекции.

Наследует

BaseObject

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

Имя	Тип	Можно задать	Тип ObjectEvent	Описание
`length`	number	нет	`change:length`	Длина массива.

Методы

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

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

clear() Collection.js, строка 126

Удаляет все элементы из коллекции.

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

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

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

Возвращает:

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

extend(arr){Collection<T>} Collection.js, строка 139

Добавляет элементы в коллекцию. Каждый элемент переданного массива добавляется в конец коллекции.

Имя	Тип	Описание
`arr`	Array.<T>	Массив.

Возвращает:

Эта коллекция.

forEach(f) Collection.js, строка 153

Перебирает все элементы, вызывая переданную функцию обратного вызова.

Имя	Тип	Описание
`f`	function	Функция, вызываемая для каждого элемента. Эта функция принимает 3 аргумента (элемент, индекс и массив). Возвращаемое значение игнорируется.

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

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

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

Возвращает:

Значение.

getArray(){Array.<T>} Collection.js, строка 168

Возвращает ссылку на базовый объект Array. Предупреждение: если изменить массив, коллекция не отправит никаких событий, а свойство "length" коллекции перестанет соответствовать фактической длине массива.

Возвращает:

Массив.

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

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

Возвращает:

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

getLength(){number} Collection.js, строка 188

Возвращает длину этой коллекции.

Возвращает:

Длина массива.

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

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

Возвращает:

Объект.

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

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

Возвращает:

Ревизия.

insertAt(index, elem) Collection.js, строка 198

Вставляет элемент по указанному индексу.

Имя	Тип	Описание
`index`	number	Индекс.
`elem`	T	Элемент.

item(index){T} Collection.js, строка 178

Возвращает элемент по указанному индексу.

Имя	Тип	Описание
`index`	number	Индекс.

Возвращает:

Элемент.

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	Функция-обработчик.

Возвращает:

pop(){T | undefined} Collection.js, строка 218

Удаляет и возвращает последний элемент коллекции. Если коллекция пуста, возвращает undefined.

Возвращает:

Элемент.

push(elem){number} Collection.js, строка 228

Добавляет переданный элемент в конец коллекции.

Имя	Тип	Описание
`elem`	T	Элемент.

Возвращает:

Новая длина коллекции.

remove(elem){T | undefined} Collection.js, строка 240

Удаляет первое вхождение элемента из коллекции.

Имя	Тип	Описание
`elem`	T	Элемент.

Возвращает:

Удалённый элемент или undefined, если элемент не найден.

removeAt(index){T | undefined} Collection.js, строка 257

Удаляет и возвращает элемент по указанному индексу. Если коллекция не содержит элемент с таким индексом, возвращает undefined.

Имя	Тип	Описание
`index`	number	Индекс.

Возвращает:

Значение.

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

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

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

setAt(index, elem) Collection.js, строка 278

Задаёт элемент по указанному индексу.

Имя	Тип	Описание
`index`	number	Индекс.
`elem`	T	Элемент.

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	Удалить без вызова события.