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