control.Manager
Менеджер элементов управления.
Конструктор | Поля | Методы
Конструктор
control.Manager(map[, controls[, options]])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Map Экземпляр карты. |
— |
Тип: String[]|IControl[] Элементы управления, которые требуется разместить на карте изначально. |
|
— |
Тип: Object Опции менеджера. |
|
10 |
Тип: Number Отступ элементов управления друг от друга и от краёв карты. Задаётся в пикселях. |
|
— |
Тип: IPane Контейнер для всех элементов управления. |
|
['small', 'medium', 'large'] |
Тип: String[] Массив размеров, начиная от наименьшего к наибольшему. |
* Обязательный параметр/опция.
Поля
Имя |
Тип |
Описание |
Менеджер событий. |
||
Опции менеджера. |
||
Состояние менеджера. Имена полей, доступных через метод data.Manager.get:
|
Методы
Имя |
Возвращает |
Описание |
Добавляет элемент управления в менеджер. |
||
Вызывает функцию-обработчик для всех элементов управления. |
||
IControl|null |
Возвращает элемент управления или null, если элемент не найден. |
|
Возвращает объект-обещание, который подтверждается HTML-элементом, в который должен разместиться дочерний элемент. |
||
HTMLElement |
Возвращает контейнер, в который будут добавлены элементы контрола. |
|
getMap() |
Возвращает ссылку на карту. |
|
Integer |
Возвращает -1, если элемент управления не найден, либо индекс элемента в менеджере. |
|
Удаление элемента управления из менеджера. |
Описание полей
events
{event.Manager} events
Менеджер событий.
options
{option.Manager} options
Опции менеджера.
state
{data.Manager} state
Состояние менеджера. Имена полей, доступных через метод data.Manager.get:
- size - состояние в котором находятся элементы управления.
Описание методов
add
{control.Manager} add(control[, options])
Добавляет элемент управления в менеджер.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: IControl|String Элементы управления, заданные экземплярами классов, реализующих интерфейс IControl либо ключами. Возможные значения ключей:
Кроме того, вы можете задавать один из предустановленных наборов элементов управления с помощью специальных ключей:
|
|
— |
Тип: Object Опции элемента управления. |
|
"right" |
Тип: String Сторона, по которой нужно выравнивать элемент управления. Может принимать три значения: "left", "right" или "none". При значении "left" или "right" элементы управления выстраиваются друг за другом, начиная от левого или правого края карты соответственно. При значении "none" элементы управления позиционируется только по значениям опций left, right, bottom, top относительно границ карты. |
|
0 |
Тип: Number Приоритет расположения элемента управления. Элемент с максимальным приоритетом находится ближе к указанному в свойстве float краю карты. Не работает при float = "none". |
|
— |
Тип: Object Объект, описывающий позицию элемента управления. При указании опции position значение опции float автоматически трактуется как "none". |
|
'auto' |
Тип: Number|String Положение относительно нижнего края карты. Работает только при float = none. |
|
'auto' |
Тип: Number|String Положение относительно левого края карты. Работает только при float = none. |
|
'auto' |
Тип: Number|String Положение относительно правого края карты. Работает только при float = none. |
|
'auto' |
Тип: Number|String Положение относительно верхнего края карты. Работает только при float = none. |
* Обязательный параметр/опция.
Пример:
map.controls
.add('zoomControl')
.add('typeSelector');
each
{control.Manager} each(callback, context)
Вызывает функцию-обработчик для всех элементов управления.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Function Функция-обработчик. На вход получает элемент коллекции. При возвращении функцией значения false перебор останавливается. |
|
— |
Тип: Object Контекст вызываемой функции. |
* Обязательный параметр/опция.
get
{IControl|null} get(index)
Возвращает элемент управления или null, если элемент не найден.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number|String Индекс искомого элемента или его ключ. |
* Обязательный параметр/опция.
getChildElement
{vow.Promise} getChildElement(control)
Возвращает объект-обещание, который подтверждается HTML-элементом, в который должен разместиться дочерний элемент.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: IControl Элемент управления. |
* Обязательный параметр/опция.
getContainer
{HTMLElement} getContainer()
Возвращает контейнер, в который добавляются элементы управления.
getMap
{Map} getMap()
Возвращает ссылку на карту.
indexOf
{Integer} indexOf(childToFind)
Возвращает -1, если элемент управления не найден, либо индекс элемента в менеджере.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: String |
Элемент управления или его ключ. |
* Обязательный параметр/опция.
remove
{control.Manager} remove(control)
Удаление элемента управления из менеджера.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: IControl|String Удаляемый элемент управления, либо его ключ. |
* Обязательный параметр/опция.
Обязательный параметр.