map.control.Manager. Статьи

JavaScript API 2.0

map

map.control

map.control.Manager

Менеджер элементов управления карты. У каждой карты уже есть собственный менеджер контролов, доступный как map.controls. Не инстанцируйте экземпляры этого класса без необходимости.

См.: Map.controls

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

Конструктор

map.control.Manager(map, controls)

Параметры:


Параметр	Значение по умолчанию	Описание
map *	—	Тип: Map Ссылка на объект карты.
controls *	—	Тип: String[]\|IControl[] Элементы управления, заданные экземплярами классов, реализующих интерфейс 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.


Параметр	Значение по умолчанию	Описание
map *	—	Тип: Map Ссылка на объект карты.
controls *	—	Тип: String[]\|IControl[] Элементы управления, заданные экземплярами классов, реализующих интерфейс 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.

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

Пример:

map.controls
    .add('zoomControl')
    .add('miniMap')
    .add('typeSelector')
    .add('mapTools');

Поля


Имя	Тип	Описание
events	IEventManager	Менеджер событий. Унаследовано от IEventEmitter.
options	IOptionManager	Менеджер опций. Унаследовано от ICustomizable.


Имя	Тип	Описание
events	IEventManager	Менеджер событий. Унаследовано от IEventEmitter.
options	IOptionManager	Менеджер опций. Унаследовано от ICustomizable.

События


Имя	Описание
add	Произошло добавление дочернего объекта. Унаследовано от ICollection.
mapchange	Сменилась карта. Поля данных: oldMap - старая карта; newMap - новая карта. Унаследовано от IParentOnMap.
optionschange	Изменение в опциях объекта. Унаследовано от ICustomizable.
remove	Произошло удаление дочернего объекта. Унаследовано от ICollection.


Имя	Описание
add	Произошло добавление дочернего объекта. Унаследовано от ICollection.
mapchange	Сменилась карта. Поля данных: oldMap - старая карта; newMap - новая карта. Унаследовано от IParentOnMap.
optionschange	Изменение в опциях объекта. Унаследовано от ICustomizable.
remove	Произошло удаление дочернего объекта. Унаследовано от ICollection.

Методы


Имя	Возвращает	Описание
add(control[, position])	map.control.Manager	Добавляет элемент управления на карту.
each(callback[, context])		Перебирает все элементы коллекции, вызывая для каждого функцию-обработчик.
getIterator()	IIterator	Returns итератор по коллекции. Унаследован от ICollection.
getMap()	Map	Returns ссылку на карту. Унаследован от IParentOnMap.
remove(control)	map.control.Manager	Удаляет элемент управления с карты.


Имя	Возвращает	Описание
add(control[, position])	map.control.Manager	Добавляет элемент управления на карту.
each(callback[, context])		Перебирает все элементы коллекции, вызывая для каждого функцию-обработчик.
getIterator()	IIterator	Returns итератор по коллекции. Унаследован от ICollection.
getMap()	Map	Returns ссылку на карту. Унаследован от IParentOnMap.
remove(control)	map.control.Manager	Удаляет элемент управления с карты.

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

add

{map.control.Manager} add(control[, position])

Добавляет элемент управления на карту.

Returns ссылку на себя.

Параметры:


Параметр	Значение по умолчанию	Описание
control *	—	Тип: IControl\|String Элемент управления или его ключ.
position	—	Тип: Object Позиция элемента управления на карте. Задаётся в виде объекта с полями left/right и top/bottom (например, так: { left: 5, top: 5 }). При указании этого параметра экземпляру элемента управления будет задана опция position с указанным значением.


Параметр	Значение по умолчанию	Описание
control *	—	Тип: IControl\|String Элемент управления или его ключ.
position	—	Тип: Object Позиция элемента управления на карте. Задаётся в виде объекта с полями left/right и top/bottom (например, так: { left: 5, top: 5 }). При указании этого параметра экземпляру элемента управления будет задана опция position с указанным значением.