ol/Collection~Коллекция

Расширяет

• БазовыйОбъект

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

Имя	Тип	Изменяемое	Тип события объекта	Описание
length	число	нет	change:length	Длина массива.

Методы

changed() inherited

Observable.js, line 68

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

clear()

Collection.js, line 126

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

dispatchEvent(event){boolean | undefined} inherited

events/Target.js, line 85

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

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

Возвращает:

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

extend(arr){Collection<T>}

Collection.js, line 139

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

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

Возвращает:

Данную коллекцию.

forEach(f)

Collection.js, line 153

Итерирует по каждому элементу, вызывая предоставленный обратный вызов.

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

get(key){*} inherited

Object.js, line 135

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

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

Возвращает:

Значение.

getArray(){Array.<T>}

Collection.js, line 168

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

Возвращает:

Массив.

getKeys(){Array.<string>} inherited

Object.js, line 148

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

Возвращает:

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

getLength(){number}

Collection.js, line 188

Получить длину этой коллекции.

Возвращает:

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

getProperties(){Object.<string, *>} inherited

Object.js, line 157

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

Возвращает:

Объект.

getRevision(){number} inherited

Observable.js, line 79

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

Возвращает:

Ревизию.

insertAt(index, elem)

Collection.js, line 198

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

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

item(index){T}

Collection.js, line 178

Получить элемент в указанном индексе.

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

Возвращает:

Элемент.

on(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, line 152

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

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

Результат:

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

once(type, listener){EventsKey | Array<EventsKey>} inherited

Observable.js, строка 164

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

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

Результат:

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

pop(){T | undefined}

Collection.js, строка 218

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

Результат:

Элемент.

push(elem){число}

Collection.js, строка 228

Вставка предоставленного элемента в конец коллекции.

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

Результат:

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

remove(elem){T | undefined}

Collection.js, строка 243

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

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

Результат:

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

removeAt(index){T | undefined}

Collection.js, строка 260

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

Имя	Тип	Описание
index	число	Индекс.

Результат:

Значение.

set(key, value, silent) inherited

Object.js, строка 215

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

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

setAt(index, elem)

Collection.js, строка 281

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

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

setProperties(values, silent) inherited

Object.js, строка 235

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

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

un(type, listener) inherited

Observable.js, строка 173

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

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

unset(key, silent) inherited

Object.js, строка 259

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

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