control.ToolBar

Расширяет control.Group.

Элемент управления "Тулбар".

Конструктор

control.ToolBar([params[, options]])

Параметры:

Параметр	Значение по умолчанию	Описание
`params`	—	Тип: Object\|IControl[] Настройки группы элементов управления. Если в качестве настроек передан массив элементов управления, он трактуется как список дочерних элементов.
`params.items`	—	Тип: IControl[] Список дочерних элементов.
`options`	—	Тип: Object Опции.
`options.position`	{ top: 5, left: 5 }	Тип: Object Положение элемента управления над картой. Задается в виде объекта со следующими полями: • top - отступ от верхнего края контейнера карты в пикселах; • right - отступ от правого края контейнера карты в пикселах; • bottom - отступ от нижнего края контейнера карты в пикселах; • left - отступ от левого края контейнера карты в пикселах. Если при этом заданы одновременно и top, и bottom, то значение bottom игнорируется. Аналогично, если заданы одновременно и left, и right, то значение right игнорируется. Если элемент управления добавляется в группу элементов (например, в тулбар или раскрывающийся список), то значение position не применяется.
`options.visible`	true	Тип: Boolean Признак того, что элемент управления отображается.

Пример:

map.controls.add(new ymaps.control.ToolBar([
    new ymaps.control.Button({data: { content: 'Кнопка раз' }}),
    new ymaps.control.Button({data: { content: 'Кнопка два' }})
]));

Поля

Имя	Тип	Описание
data	data.Manager	Данные тулбара.
events	IEventManager	Менеджер событий. Унаследовано от IEventEmitter.
options	IOptionManager	Менеджер опций. Унаследовано от ICustomizable.
state	data.Manager	Состояние элемента управления. Имена полей, доступных через метод data.Manager.get: • contentWidth - общая ширина дочерних элементов.

События

Имя	Описание
add	Произошло добавление дочернего объекта. Унаследовано от ICollection.
childcontainerchange	Изменение дом-элемента, в который добавляются дочерние элементы группы. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • newChildContainerElement - новый дом-элемент для дочерних элементов; • oldChildContainerElement - старый элемент для дочерних элементов. Унаследовано от control.Group.
mapchange	Сменилась карта. Поля данных: • oldMap - старая карта; • newMap - новая карта. Унаследовано от IParentOnMap.
optionschange	Изменение в опциях объекта. Унаследовано от ICustomizable.
parentchange	Сменился родительский объект. Поля данных: • oldParent - старый родитель; • newParent - новый родитель. Унаследовано от IChild.
remove	Произошло удаление дочернего объекта. Унаследовано от ICollection.

Методы

Имя	Возвращает	Описание
add(item[, positionIndex])	control.Group	Добавляет элемент управления в группу. Элемент можно добавлять, передав экземпляр класса, реализующего интерфейс 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. Унаследован от control.Group.
each(callback[, context])	control.Group	Перебирает все элементы коллекции, вызывая для каждого функцию-обработчик. Унаследован от control.Group.
filter(callback)	IChildOnMap[]	Функция для выборки дочерних элементов по условию. Унаследован от control.Group.
get()	IChildOnMap	Returns ссылку на объект контрола, добавленного по ключу или по индексу. Унаследован от control.Group.
getAll()	IChildOnMap[]	Returns массив дочерних элементов контрола. Унаследован от control.Group.
getChildElement(child)	HTMLElement	Возвращает для своего дочернего объекта HTML-элемент, в котором он должен размещаться. Унаследован от IControlParent.
getContainer()	HTMLElement	Returns контейнер, в который добавляются дочерние элементы контрола. Унаследован от control.Group.
getIterator()	IIterator	Returns итератор по коллекции. Унаследован от ICollection.
getLength()	Number	Returns количество дочерних элементов. Унаследован от control.Group.
getMap()	Map	Returns ссылку на карту. Унаследован от IParentOnMap.
getParent()	IControlParent	Returns ссылку на родительский объект. Унаследован от IControl.
indexOf(childToFind)	Integer	Returns индекс дочернего элемента в группе. Унаследован от control.Group.
remove(item)	control.Group	Удаляет элемент управления из группы. Унаследован от control.Group.
removeAll()	control.Group	Удаляет все дочерние элементы из группы. Унаследован от control.Group.
setParent(parent)	IChildOnMap	Устанавливает родительский объект. Унаследован от IControl.

Описание полей

data

{data.Manager} data

Данные тулбара.

state

{data.Manager} state

Состояние элемента управления. Имена полей, доступных через метод data.Manager.get:

• contentWidth - общая ширина дочерних элементов.

Была ли статья полезна?

control.storage

control.ToolBarSeparator