Документация
Справочник JavaScript API
2.1.64 (текущая версия)
collection
interactivityModel
Интерфейсы

Collection

Расширяет ICollection, collection.Item.

Базовая реализация коллекции объектов на карте.

Конструктор | Поля | События | Методы

Конструктор

Collection([options])

Параметры:

ПараметрЗначение по умолчаниюОписание
options

Тип: Object

Опции коллекции.

Поля

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

Менеджер событий.

Унаследовано от IEventEmitter.

options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.

События

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

Произошло добавление дочернего объекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • child - добавленный дочерний элемент.

mapchange

Сменилась карта. Поля данных:

  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IParentOnMap.

optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.

parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild.

remove

Произошло удаление дочернего объекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • child - удаленный дочерний элемент.

Методы

ИмяВозвращаетОписание
add(child)

Collection

Добавляет элемент в коллекцию.

each(callback[, context])

Collection

Вызывает функцию-обработчик для всех элементов коллекции.

filter(filterFunction)

Object[]

Вызывает функцию-фильтр для всех элементов коллекции. При возвращении фильтром ненулевого значения элемент коллекции попадает в конечный массив.

get(index)

Object

Возвращает элемент коллекции или null, если номер находится вне диапозона номеров коллекции.

getAll()

Object[]

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

getIterator()

IIterator

Возвращает итератор для перебора элементов коллекции.

getLength()

Number

Возвращает количество элементов коллекции.

getMap()

Map

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

Унаследован от collection.Item.

getParent()

IParentOnMap

Возвращает родительский объект.

Унаследован от collection.Item.

indexOf(childToFind)

Number

Возвращает порядковый номер объекта в коллекции либо -1, если объект не найден.

onAddToMap(map)

Функция, которая вызывается при добавлении элемента на карту. Для выполнения дополнительных действий при добавлении объекта на карту переопределите эту функцию.

Унаследован от collection.Item.

onRemoveFromMap(oldMap)

Функция, которая вызывается при удалении элемента с карты. Для выполнения дополнительных действий при удалении объекта с карты переопределите эту функцию.

Унаследован от collection.Item.

remove(child)

Collection

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

removeAll()

Collection

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

setParent(parent)

collection.Item

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

Унаследован от collection.Item.

Описание событий

add

Произошло добавление дочернего объекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • child - добавленный дочерний элемент.

remove

Произошло удаление дочернего объекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • child - удаленный дочерний элемент.

Описание методов

add

Добавляет элемент в коллекцию.

Возвращает cсылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
child *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: collection.Item

Элемент, который необходимо добавить.

* Обязательный параметр/опция.

each

Вызывает функцию-обработчик для всех элементов коллекции.

Возвращает cсылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
callback *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Function

Функция-обработчик. На вход получает элемент коллекции. При возвращении функцией значения false перебор останавливается.

context

Тип: Object

Контекст вызываемой функции.

* Обязательный параметр/опция.

filter

{Object[]} filter(filterFunction)

Вызывает функцию-фильтр для всех элементов коллекции. При возвращении фильтром ненулевого значения элемент коллекции попадает в конечный массив.

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

Параметры:

ПараметрЗначение по умолчаниюОписание
filterFunction *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Function

Функция, которая является фильтром для объектов коллекции. Первым параметром принимает элемент из коллекции. Должна возвращать булевое значение.

* Обязательный параметр/опция.

get

{Object} get(index)

Возвращает элемент коллекции или null, если номер находится вне диапозона номеров коллекции.

Параметры:

ПараметрЗначение по умолчаниюОписание
index *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Number

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

* Обязательный параметр/опция.

getAll

{Object[]} getAll()

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

getIterator

{IIterator} getIterator()

Возвращает итератор для перебора элементов коллекции.

getLength

{Number} getLength()

Возвращает количество элементов коллекции.

indexOf

{Number} indexOf(childToFind)

Возвращает порядковый номер объекта в коллекции либо -1, если объект не найден.

Параметры:

ПараметрЗначение по умолчаниюОписание
childToFind *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Object

Искомый объект.

* Обязательный параметр/опция.

remove

{Collection} remove(child)

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

Возвращает cсылку на себя.

Параметры:

ПараметрЗначение по умолчаниюОписание
child *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: collection.Item

Элемент, который необходимо удалить.

* Обязательный параметр/опция.

removeAll

{Collection} removeAll()

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

Возвращает cсылку на себя.