YMaps.Group

Класс для создания набора объектов.

Позволяет объединять в группы объекты любого типа. Если требуется создать группу из объектов пользовательского класса, то класс YMaps.Group может быть расширен по примеру класса YMaps.OverlayGroup.

КонструкторКонструктор

ПоляПоля

СобытияСобытия

МетодыМетоды

Подробное описание конструктораПодробное описание конструктора

YMaps.Group()

Создает набор объектов.

Подробное описание полейПодробное описание полей

EventsEvents

Object Events

Список событий группы объектов.

Подробное описание событийПодробное описание событий

AddAdd

Add

Добавление объекта в группу.
В callback-функцию передаются три аргумента:

• указатель на группу;
• указатель на добавленный объект;
• индекс добавленного объекта.

RemoveRemove

Remove

Удаление объекта из группы.
В callback-функцию передаются три аргумента:

• указатель на группу;
• указатель на удаленный объект;
• индекс удаляемого объекта.

Подробное описание методовПодробное описание методов

AddAdd

add(object, index)

Добавляет объект в группу. Генерирует событие YMaps.Group.Add.

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
object	Object	Object[]
index	Integer			Позиция, в которую нужно добавить object.

filterfilter

{Object[]} filter(callback, context, noRecursion)

Отбирает объекты группы, удовлетворяющие условиям, заданным в функции проверки. Возвращает массив отобранных объектов.

По умолчанию отбор объектов для проверки происходит рекурсивно, то есть, если группа содержит вложенные группы, то отбор будет происходить и в них тоже.

Пример:

// Осуществляет рекурсивный отбор объектов с заданным значением свойства
var filteredObj = group.filter(function (obj) {
    return obj.property == "filter";
});

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
callback	Function			Функция проверки.
context	Object		null	Контекст выполнения функции.
noRecursion	Object		false	true - запретить рекурсивный отбор объектов внутри группы, false - разрешить.

Возвращает:

forEachforEach

forEach(callback, context)

Выполняет callback-функцию для каждого объекта группы.

В функцию передаются следующие параметры:

• указатель на объект;
• индекс объекта в группе;
• указатель на саму группу.

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
callback	Function			Функция, выполняемая для каждого объекта.
context	Object			Контекст выполнения функции.

getget

{Object} get(index)

Возвращает объект по его индексу в группе. Индекс может принимать отрицательные значения.

Пример:

group.get(0) // Берет первый объект в группе.
group.get(5) // Берет пятый объект в группе.
group.get(-1) // Берет последний объект в группе.
group.get(-3) // Берет третий объект с конца.

Параметры:

Возвращает:

indexOfindexOf

{Integer} indexOf(object)

Ищет объект в группе и возвращает его индекс.

Параметры:

Возвращает:

lengthlength

{Integer} length()

Возвращает количество объектов в группе.

Возвращает:

removeremove

{Object[]} remove(object)

Удаляет объект или массив объектов из группы. Генерирует событие YMaps.Group.Remove.

Параметры:

Возвращает:

removeAllremoveAll

removeAll()

Удаляет все объекты из группы.

splicesplice

{Object[]} splice(index, number)

Удаляет объекты из группы. Если необходимо, вставляет на их место другие объекты. Объекты, которые будут вставлены вместо удаляемых, передаются как дополнительные параметры (после параметра number).

Пример:

// Удаляет второй объект.
group.splice(1, 1);
// Вставляет новый объект obj во вторую позицию.
group.splice(1, 0, obj);
// Заменяет второй объект на новый объект obj.
group.splice(1, 1, obj);

Параметры:

Возвращает: