control.MapTools

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

Тулбар со стандартными кнопками.

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

Конструктор

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

Параметры:

Параметр Значение по умолчанию Описание
params —

Тип: Object|IControl[]|String[]

Параметры тулбара или список кнопок, которые будут добавлены по умолчанию.
params.items —

Тип: IControl[]|String[]

Кнопки которые будут добавленны в тулбар. Могут задаваться экземплярами класса, реализующего интерфейс IControl, либо ключами. Для этих кнопок будет созданна специальная группа. Можно использовать следующие ключи:
  • "default" - короткий синоним для стандартного набора кнопок;
  • "drag" - кнопка "Навигация";
  • "magnifier" - кнопка "Выделение";
  • "ruler" - кнопка "Линейка".
По умолчанию автоматически добавляются стандартные кнопки "Навигация", "Выделение" и "Линейка". Получить ссылку на группу, содержащую эти объекты, можно будет через метод getDefaultGroup.
options —

Тип: Object

Опции элемента управления.
options.position { top: 5, right: 5 }

Тип: Object

Положение элемента управления над картой. Задается в виде объекта со следующими полями:
  • top - отступ от верхнего края контейнера карты в пикселах;
  • right - отступ от правого края контейнера карты в пикселах;
  • bottom - отступ от нижнего края контейнера карты в пикселах;
  • left - отступ от левого края контейнера карты в пикселах.
Если при этом заданы одновременно и top, и bottom, то значение bottom игнорируется. Аналогично, если заданы одновременно и left, и right, то значение right игнорируется. Если элемент управления добавляется в группу элементов (например, в тулбар или раскрывающийся список), то значение position не применяется.
options.visible true

Тип: Boolean

Признак того, что элемент управления отображается.
Параметр Значение по умолчанию Описание
params —

Тип: Object|IControl[]|String[]

Параметры тулбара или список кнопок, которые будут добавлены по умолчанию.
params.items —

Тип: IControl[]|String[]

Кнопки которые будут добавленны в тулбар. Могут задаваться экземплярами класса, реализующего интерфейс IControl, либо ключами. Для этих кнопок будет созданна специальная группа. Можно использовать следующие ключи:
  • "default" - короткий синоним для стандартного набора кнопок;
  • "drag" - кнопка "Навигация";
  • "magnifier" - кнопка "Выделение";
  • "ruler" - кнопка "Линейка".
По умолчанию автоматически добавляются стандартные кнопки "Навигация", "Выделение" и "Линейка". Получить ссылку на группу, содержащую эти объекты, можно будет через метод getDefaultGroup.
options —

Тип: Object

Опции элемента управления.
options.position { top: 5, right: 5 }

Тип: Object

Положение элемента управления над картой. Задается в виде объекта со следующими полями:
  • top - отступ от верхнего края контейнера карты в пикселах;
  • right - отступ от правого края контейнера карты в пикселах;
  • bottom - отступ от нижнего края контейнера карты в пикселах;
  • left - отступ от левого края контейнера карты в пикселах.
Если при этом заданы одновременно и top, и bottom, то значение bottom игнорируется. Аналогично, если заданы одновременно и left, и right, то значение right игнорируется. Если элемент управления добавляется в группу элементов (например, в тулбар или раскрывающийся список), то значение position не применяется.
options.visible true

Тип: Boolean

Признак того, что элемент управления отображается.

Пример: 

var mapTools = new ymaps.control.MapTools({ items: ["drag", "magnifier"]});
// получаем доступ к кнопке, добавленной по умолчанию
mapTools.getDefaultGroup().get("drag");

Поля

Имя Тип Описание
data data.Manager

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

Унаследовано от control.ToolBar.
events IEventManager

Менеджер событий.

Унаследовано от IEventEmitter.
options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.
state data.Manager
Состояние элемента управления. Имена полей, доступных через метод data.Manager.get:
  • contentWidth - общая ширина дочерних элементов.

Унаследовано от control.ToolBar.
Имя Тип Описание
data data.Manager

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

Унаследовано от control.ToolBar.
events IEventManager

Менеджер событий.

Унаследовано от IEventEmitter.
options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.
state data.Manager
Состояние элемента управления. Имена полей, доступных через метод data.Manager.get:
  • contentWidth - общая ширина дочерних элементов.

Унаследовано от control.ToolBar.

События

Имя Описание
add

Произошло добавление дочернего объекта.

Унаследовано от ICollection.
childcontainerchange
Изменение дом-элемента, в который добавляются дочерние элементы группы. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • newChildContainerElement - новый дом-элемент для дочерних элементов;
  • oldChildContainerElement - старый элемент для дочерних элементов.

Унаследовано от control.Group.
mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IParentOnMap.
optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.
parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild.
remove

Произошло удаление дочернего объекта.

Унаследовано от ICollection.
Имя Описание
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, или по ключу.

Возожные значения ключей:

Унаследован от 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.
getDefaultGroup()

control.RadioGroup

Returns ссылку на группу стандартных элементов управления картой.
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.
Имя Возвращает Описание
add(item[, positionIndex])

control.Group

Добавляет элемент управления в группу. Элемент можно добавлять, передав экземпляр класса, реализующего интерфейс IControl, или по ключу.

Возожные значения ключей:

Унаследован от 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.
getDefaultGroup()

control.RadioGroup

Returns ссылку на группу стандартных элементов управления картой.
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.

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

getDefaultGroup

{control.RadioGroup} getDefaultGroup()

Returns ссылку на группу стандартных элементов управления картой.