Collection
Расширяет ICollection, collection.Item.
Базовая реализация коллекции объектов на карте.
Конструктор | Поля | События | Методы
Конструктор
Collection([options])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Опции коллекции. |
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от ICustomizable. |
События
Имя |
Описание |
Произошло добавление дочернего объекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
|
|
Сменилась карта. Поля данных:
Унаследовано от IParentOnMap. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
|
Произошло удаление дочернего объекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
|
Методы
Имя |
Возвращает |
Описание |
Добавляет элемент в коллекцию. |
||
Вызывает функцию-обработчик для всех элементов коллекции. |
||
Object[] |
Вызывает функцию-фильтр для всех элементов коллекции. При возвращении фильтром ненулевого значения элемент коллекции попадает в конечный массив. |
|
Object |
Возвращает элемент коллекции или null, если номер находится вне диапозона номеров коллекции. |
|
getAll() |
Object[] |
Возвращает массив со всеми элементами коллекции. |
Возвращает итератор для перебора элементов коллекции. |
||
Number |
Возвращает количество элементов коллекции. |
|
getMap() |
Возвращает карту, которой принадлежит элемент коллекции. Унаследован от collection.Item. |
|
Возвращает родительский объект. Унаследован от collection.Item. |
||
Number |
Возвращает порядковый номер объекта в коллекции либо -1, если объект не найден. |
|
Функция, которая вызывается при добавлении элемента на карту. Для выполнения дополнительных действий при добавлении объекта на карту переопределите эту функцию. Унаследован от collection.Item. |
||
Функция, которая вызывается при удалении элемента с карты. Для выполнения дополнительных действий при удалении объекта с карты переопределите эту функцию. Унаследован от collection.Item. |
||
Удаляет элемент из коллекции. |
||
Удаляет все элементы коллекции. |
||
Устанавливает родителя для заданного элемента коллекции. Унаследован от collection.Item. |
Описание событий
add
Произошло добавление дочернего объекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
- child - добавленный дочерний элемент.
remove
Произошло удаление дочернего объекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
- child - удаленный дочерний элемент.
Описание методов
add
{Collection} add(child)
Добавляет элемент в коллекцию.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: collection.Item Элемент, который необходимо добавить. |
* Обязательный параметр/опция.
each
{Collection} each(callback[, context])
Вызывает функцию-обработчик для всех элементов коллекции.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Function Функция-обработчик. На вход получает элемент коллекции. При возвращении функцией значения false перебор останавливается. |
|
— |
Тип: Object Контекст вызываемой функции. |
* Обязательный параметр/опция.
filter
{Object[]} filter(filterFunction)
Вызывает функцию-фильтр для всех элементов коллекции. При возвращении фильтром ненулевого значения элемент коллекции попадает в конечный массив.
Возвращает массив из элементов, которые попали в выборку.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Function Функция, которая является фильтром для объектов коллекции. Первым параметром принимает элемент из коллекции. Должна возвращать булевое значение. |
* Обязательный параметр/опция.
get
{Object} get(index)
Возвращает элемент коллекции или null, если номер находится вне диапозона номеров коллекции.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number Порядковый номер элемента в коллекции. |
* Обязательный параметр/опция.
getAll
{Object[]} getAll()
Возвращает массив со всеми элементами коллекции.
getIterator
{IIterator} getIterator()
Возвращает итератор для перебора элементов коллекции.
getLength
{Number} getLength()
Возвращает количество элементов коллекции.
indexOf
{Number} indexOf(childToFind)
Возвращает порядковый номер объекта в коллекции либо -1, если объект не найден.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Искомый объект. |
* Обязательный параметр/опция.
remove
{Collection} remove(child)
Удаляет элемент из коллекции.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: collection.Item Элемент, который необходимо удалить. |
* Обязательный параметр/опция.
removeAll
{Collection} removeAll()
Удаляет все элементы коллекции.
Возвращает ссылку на себя.
Обязательный параметр.