control.TypeSelector
Расширяет control.ListBox.
Элемент управления "Типы карты". В данный элемент управления можно добавлять элементы списка, которые описывают типы карты, а также дополнительные элементы. Ключ элемента управления в хранилище control.storage — "typeSelector".
Конструктор | Поля | События | Методы
Конструктор
control.TypeSelector([parameters])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: String[]|MapType[]|Object Объект с описаниями параметров элемента управления. Если передан массив, то он трактуется как массив типов карты. |
|
— |
Тип: String[]|MapType[] Массив конструкторов типов карты или ключей. Если параметр отсутствует, в элемент будет добавлен стандартный набор типов карты. Список доступных типов карты:
|
|
— |
Тип: Object Опции элемента управления. |
|
false |
Тип: Boolean Регистрирует ли элемент управления свои размеры в менеджере отступов карты map.margin.Manager. |
|
true |
Тип: Boolean Флаг, разрешающий сворачиваение списка при потере фокуса на кнопке. Например при клике на документ. |
|
3000 |
Тип: Number Временной интервал, по истечении которого раскрытый список автоматически закрывается. |
|
true |
Тип: Boolean Флаг, разрешающий автоматическое разворачивание/сворачивание списка по клику. |
|
"right" |
Тип: String Сторона, по которой нужно выравнивать элемент управления. Может принимать три значения: "left", "right" или "none". При значении "left" или "right" элементы управления выстраиваются друг за другом, начиная от левого или правого края карты соответственно. При значении "none" элементы управления позиционируется только по значениям опций left, right, bottom, top относительно границ карты. Также смотрите описание опции position. |
|
200 |
Тип: Number Приоритет расположения элемента управления. Элемент с максимальным приоритетом находится ближе к указанному в свойстве float краю карты. Не работает при float = "none". |
|
— |
Тип: Function|String Конструктор макета элемента управления, реализующий интерфейсы ISelectableControlLayout и IGroupControlLayout или ключ макета в хранилище layout.storage. В конструктор макета передается объект, содержащий поля:
|
|
[30, 65, 85] |
Тип: Number|Number[] Максимальная ширина кнопки списка при различных состояниях. Если задано число, то считается, что кнопка имеет одинаковые максимальные размеры во всех состояниях. Если задан массив, то он будет трактоваться как максимальная ширина кнопки в различных состояниях - от меньшего к большему. |
|
'ifMercator' |
Тип: String Показывает или скрывает элемент "Панорамы". Возможные значения:
|
|
— |
Тип: Object Объект, описывающий позицию элемента управления. При указании опции position значение опции float автоматически трактуется как "none". |
|
'auto' |
Тип: Number|String Положение относительно нижнего края карты. |
|
'auto' |
Тип: Number|String Положение относительно левого края карты. |
|
'auto' |
Тип: Number|String Положение относительно правого края карты. |
|
'auto' |
Тип: Number|String Положение относительно верхнего края карты. |
|
true |
Тип: Boolean Признак того, что элемент управления отображается. |
|
— |
Тип: Object Состояние элемента управления. |
|
false |
Тип: Boolean Признак, развернут ли список. |
Пример:
map.controls.add(new ymaps.control.TypeSelector(['yandex#map', 'yandex#hybrid']));
Поля
Имя |
Тип |
Описание |
Данные элемента управления. |
||
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от IControl. |
||
Состояние выпадающего списка. Имена полей, доступных через метод data.Manager.get:
Унаследовано от control.ListBox. |
События
Имя |
Описание |
Произошло добавление дочернего объекта. Унаследовано от ICollection. |
|
Щелчок по заголовку списка. Экземпляр класса Event. Унаследовано от control.ListBox. |
|
Список закрыт. Экземпляр класса Event. Унаследовано от control.ListBox. |
|
Список открыт. Экземпляр класса Event. Унаследовано от control.ListBox. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
|
Событие, сигнализирующее о том, что кнопка была нажата. В отличии от click генерируется только если состояние isEnabled == true. Экземпляр класса Event. Унаследовано от control.ListBox. |
|
Произошло удаление дочернего объекта. Унаследовано от ICollection. |
Методы
Имя |
Возвращает |
Описание |
Добавляет в коллекцию дочерний объект. Унаследован от ICollection. |
||
Добавляет тип карты в список. |
||
collapse() |
Сворачивает список. Унаследован от control.ListBox. |
|
expand() |
Раскрывает список. Унаследован от control.ListBox. |
|
Возвращает итератор по коллекции. Унаследован от ICollection. |
||
getMap() |
Возвращает ссылку на карту. |
|
IControlParent|null |
Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IControl. |
|
Boolean |
Возвращает признак того, находится ли контрол в развернутом состоянии. Унаследован от control.ListBox. |
|
Удаляет из коллекции дочерний объект. Унаследован от ICollection. |
||
Удаляет все типы карты из элемента управления. |
||
Удаляет тип карты. |
||
Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IControl. |
Описание полей
data
{data.Manager} data
Данные элемента управления.
Описание методов
addMapType
{control.TypeSelector} addMapType(mapType[, positionIndex])
Добавляет тип карты в список.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: String|MapType Тип карты. |
|
— |
Тип: Integer Позиция в списке (если не указана, новый тип карты добавляется в конец списка). Список значений positionIndex по умолчанию для стандартных типов карты:
|
* Обязательный параметр/опция.
Примеры:
1.
var typeSelector = new ymaps.control.TypeSelector([]);
typeSelector.addMapType('yandex#map', 1);
typeSelector.addMapType('yandex#hybrid', 0);
2.
// Если используется стандартный набор типов карты, и мы
// хотим добавить свой из хранилища mapType.storage между
// типами «спутник» и «схема».
var typeSelector = myMap.controls.get('typeSelector');
typeSelector.addMapType('my#mapType', 6);
getMap
{Map} getMap()
Возвращает ссылку на карту.
removeAllMapTypes
{control.TypeSelector} removeAllMapTypes()
Удаляет все типы карты из элемента управления.
Возвращает ссылку на себя.
removeMapType
{control.TypeSelector} removeMapType(mapType)
Удаляет тип карты.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: String|MapType Тип карты. |
* Обязательный параметр/опция.
Обязательный параметр.