control.Group
Расширяет IControl, IControlParent, ICustomizable, IMapObjectCollection.
Группа (упорядоченная коллекция) элементов управления.
Конструктор | Поля | События | Методы
Конструктор
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
params | — | Тип: Object|IControl[] Настройки группы элементов управления. Если в качестве настроек передан массив элементов управления, он трактуется как список дочерних элементов. |
params.items | — | Тип: IControl[] Список дочерних элементов. |
options | — | Тип: Object Опции. |
options.position | { top: 5, left: 5 } | Тип: Object Положение элемента управления над картой.
Задается в виде объекта со следующими полями:
|
options.visible | true | Тип: Boolean Признак того, что элемент управления отображается. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
params | — | Тип: Object|IControl[] Настройки группы элементов управления. Если в качестве настроек передан массив элементов управления, он трактуется как список дочерних элементов. |
params.items | — | Тип: IControl[] Список дочерних элементов. |
options | — | Тип: Object Опции. |
options.position | { top: 5, left: 5 } | Тип: Object Положение элемента управления над картой.
Задается в виде объекта со следующими полями:
|
options.visible | true | Тип: Boolean Признак того, что элемент управления отображается. |
Поля
Имя | Тип | Описание |
---|---|---|
data | data.Manager | Данные группы. |
events | IEventManager | Менеджер событий. Унаследовано от IEventEmitter. |
options | IOptionManager | Менеджер опций. Унаследовано от ICustomizable. |
state | data.Manager | Состояние группы. |
Имя | Тип | Описание |
---|---|---|
data | data.Manager | Данные группы. |
events | IEventManager | Менеджер событий. Унаследовано от IEventEmitter. |
options | IOptionManager | Менеджер опций. Унаследовано от ICustomizable. |
state | data.Manager | Состояние группы. |
События
Имя | Описание |
---|---|
add | Произошло добавление дочернего объекта. Унаследовано от ICollection. |
childcontainerchange | Изменение дом-элемента, в который добавляются дочерние элементы группы.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
|
mapchange | Сменилась карта.
Поля данных:
Унаследовано от IParentOnMap. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
parentchange | Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
remove | Произошло удаление дочернего объекта. Унаследовано от ICollection. |
Имя | Описание |
---|---|
add | Произошло добавление дочернего объекта. Унаследовано от ICollection. |
childcontainerchange | Изменение дом-элемента, в который добавляются дочерние элементы группы.
Экземпляр класса Event.
Имена полей, доступных через метод Event.get:
|
mapchange | Сменилась карта.
Поля данных:
Унаследовано от IParentOnMap. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
parentchange | Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
remove | Произошло удаление дочернего объекта. Унаследовано от ICollection. |
Методы
Имя | Возвращает | Описание |
---|---|---|
add(item[, positionIndex]) | Добавляет элемент управления в группу. Элемент можно добавлять, передав экземпляр класса, реализующего интерфейс IControl, или по ключу.
Возожные значения ключей:
| |
each(callback[, context]) | Перебирает все элементы коллекции, вызывая для каждого функцию-обработчик. | |
filter(callback) | Функция для выборки дочерних элементов по условию. | |
get() | Returns ссылку на объект контрола, добавленного по ключу или по индексу. | |
getAll() | Returns массив дочерних элементов контрола. | |
getChildElement(child) | HTMLElement | Возвращает для своего дочернего объекта HTML-элемент, в котором он должен размещаться. Унаследован от IControlParent. |
getContainer() | HTMLElement | Returns контейнер, в который добавляются дочерние элементы контрола. |
getIterator() | Returns итератор по коллекции. Унаследован от ICollection. | |
getLength() | Number | Returns количество дочерних элементов. |
getMap() | Returns ссылку на карту. Унаследован от IParentOnMap. | |
getParent() | Returns ссылку на родительский объект. Унаследован от IControl. | |
indexOf(childToFind) | Integer | Returns индекс дочернего элемента в группе. |
remove(item) | Удаляет элемент управления из группы. | |
removeAll() | Удаляет все дочерние элементы из группы. | |
setParent(parent) | Устанавливает родительский объект. Унаследован от IControl. |
Имя | Возвращает | Описание |
---|---|---|
add(item[, positionIndex]) | Добавляет элемент управления в группу. Элемент можно добавлять, передав экземпляр класса, реализующего интерфейс IControl, или по ключу.
Возожные значения ключей:
| |
each(callback[, context]) | Перебирает все элементы коллекции, вызывая для каждого функцию-обработчик. | |
filter(callback) | Функция для выборки дочерних элементов по условию. | |
get() | Returns ссылку на объект контрола, добавленного по ключу или по индексу. | |
getAll() | Returns массив дочерних элементов контрола. | |
getChildElement(child) | HTMLElement | Возвращает для своего дочернего объекта HTML-элемент, в котором он должен размещаться. Унаследован от IControlParent. |
getContainer() | HTMLElement | Returns контейнер, в который добавляются дочерние элементы контрола. |
getIterator() | Returns итератор по коллекции. Унаследован от ICollection. | |
getLength() | Number | Returns количество дочерних элементов. |
getMap() | Returns ссылку на карту. Унаследован от IParentOnMap. | |
getParent() | Returns ссылку на родительский объект. Унаследован от IControl. | |
indexOf(childToFind) | Integer | Returns индекс дочернего элемента в группе. |
remove(item) | Удаляет элемент управления из группы. | |
removeAll() | Удаляет все дочерние элементы из группы. | |
setParent(parent) | Устанавливает родительский объект. Унаследован от IControl. |
Описание полей
data
{data.Manager} data
Данные группы.
state
{data.Manager} state
Состояние группы.
Описание событий
childcontainerchange
- newChildContainerElement - новый дом-элемент для дочерних элементов;
- oldChildContainerElement - старый элемент для дочерних элементов.
Описание методов
add
{control.Group} add(item[, positionIndex])
Добавляет элемент управления в группу. Элемент можно добавлять, передав экземпляр класса, реализующего интерфейс IControl, или по ключу.
Возожные значения ключей:
- "mapTools" - стандартный тулбар с кнопками "Навигация", "Выделение" и "Линейка" control.MapTools;
- "miniMap" - обзорная карта control.MiniMap;
- "scaleLine" - масштабный отрезок control.ScaleLine;
- "searchControl" - панель поиска control.SearchControl;
- "trafficControl" - панель пробок control.TrafficControl;
- "typeSelector" - панель переключения типа карты control.TypeSelector;
- "zoomControl" - ползунок масштаба control.ZoomControl;
- "smallZoomControl" - простой ползунок масштаба control.SmallZoomControl.
Returns ссылку на себя.
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
item * | — | Тип: IControl|String Элемент управления или его ключ. |
positionIndex | — | Тип: Integer Позиция вставки элемента. Если не задана, элемент добавляется в конец списка. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
item * | — | Тип: IControl|String Элемент управления или его ключ. |
positionIndex | — | Тип: Integer Позиция вставки элемента. Если не задана, элемент добавляется в конец списка. |
* Обязательный параметр/опция.
Пример:
var groupControl = new ymaps.control.Group();
// Добавляем элемент управления типами карты.
groupControl.add(new ymaps.control.TypeSelector(), 1);
// Добавляем стандарный набор элементов управления картой.
groupControl.add(new ymaps.control.MapTools(), 0);
map.controls.add(groupControl);
each
{control.Group} each(callback[, context])
Перебирает все элементы коллекции, вызывая для каждого функцию-обработчик.
Returns ссылку на себя.
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
callback * | — | Тип: Function Функция-обработчик. |
context | — | Тип: Object Контекст выполнения функции. |
* Обязательный параметр/опция.
filter
{IChildOnMap[]} filter(callback)
Функция для выборки дочерних элементов по условию.
Returns массив дочерних элементов.
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
callback * | — | Тип: Function Функция-обработчик дочерних элементов контрола. Получает на вход ссылку на элемент контрола и возвращает значение true/false. Дочерние элементы, для которых функция-обработчик возвращает true, будут добавлены в результирующий массив. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
callback * | — | Тип: Function Функция-обработчик дочерних элементов контрола. Получает на вход ссылку на элемент контрола и возвращает значение true/false. Дочерние элементы, для которых функция-обработчик возвращает true, будут добавлены в результирующий массив. |
* Обязательный параметр/опция.
get
{IChildOnMap} get()
Returns ссылку на объект контрола, добавленного по ключу или по индексу.
Параметры:
* Обязательный параметр/опция.
getAll
{IChildOnMap[]} getAll()
Returns массив дочерних элементов контрола.
getContainer
{HTMLElement} getContainer()
Returns контейнер, в который добавляются дочерние элементы контрола.
getLength
{Number} getLength()
Returns количество дочерних элементов.
indexOf
{Integer} indexOf(childToFind)
Returns индекс дочернего элемента в группе.
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
childToFind * | — | Тип: String|IControl Дочерний элемент или его ключ. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
childToFind * | — | Тип: String|IControl Дочерний элемент или его ключ. |
* Обязательный параметр/опция.
remove
{control.Group} remove(item)
Удаляет элемент управления из группы.
Returns ссылку на себя.
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
item * | — | Тип: IControl|String Элемент управления или его ключ. |
* Обязательный параметр/опция.
removeAll
{control.Group} removeAll()
Удаляет все дочерние элементы из группы.
Returns ссылку на себя.