control.TrafficControl
Расширяет IControl, ICustomizable.
Панель управления пробками на карте.
Конструктор | Поля | События | Методы
Конструктор
control.TrafficControl([parameters])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Параметры элемента управления. |
|
— |
Тип: Object Опции элемента управления. |
|
false |
Тип: Boolean Регистрирует ли элемент управления свои размеры в менеджере отступов карты map.margin.Manager. |
|
true |
Тип: Boolean Флаг, разрешающий сворачиваение панели при потере фокуса на элементе управления. Например при клике на документ. |
|
"right" |
Тип: String Сторона, по которой нужно выравнивать элемент управления. Может принимать три значения: "left", "right" или "none". При значении "left" или "right" элементы управления выстраиваются друг за другом, начиная от левого или правого края карты соответственно. При значении "none" элементы управления позиционируется только по значениям опций left, right, bottom, top относительно границ карты. Также смотрите описание опции position. |
|
100 |
Тип: Number Приоритет расположения элемента управления. Элемент с максимальным приоритетом находится ближе к указанному в свойстве float краю карты. Не работает при float = "none". |
|
— |
Тип: Function|String Макет элемента управления. В конструктор макета передается объект, содержащий поля:
|
|
[26, 195, 195] |
Тип: Number|Number[] Максимальная ширина кнопки в различных состояниях. Если задано число, то считается, что элемент управления имеет одинаковые максимальные размеры во всех состояниях. Если задан массив, то он будет трактоваться как максимальная ширина в различных состояниях - от меньшего к большему. Количество доступных состояний задается в экземпляре класса control.Manager через опцию states. Этот класс обычно является полем Map.controls. По умолчанию у элементов управления есть три состояния - ['small', 'medium', 'large']. |
|
— |
Тип: Object Объект, описывающий позицию элемента управления. При указании опции position значение опции float автоматически трактуется как "none". |
|
'auto' |
Тип: Number|String Положение относительно нижнего края карты. |
|
'auto' |
Тип: Number|String Положение относительно левого края карты. |
|
'auto' |
Тип: Number|String Положение относительно правого края карты. |
|
'auto' |
Тип: Number|String Положение относительно верхнего края карты. |
|
'auto' |
Тип: String Параметр, отвечающий за внешний вид стандартного макета элемента управления пробками. Может принимать значения:
|
|
true |
Тип: Boolean Признак того, что элемент управления отображается. |
|
— |
Тип: Object Состояние элемента управления. |
|
'traffic#actual' |
Тип: String Ключ провайдера пробок, показываемых на карте.
|
|
false |
Тип: Boolean Показаны ли данные по пробкам на карте. |
Пример:
// Добавление на карту элемента управления пробками
// с включенными пробками "сейчас".
var trafficControl = new ymaps.control.TrafficControl({state: {trafficShown: true}});
map.controls.add(trafficControl, {top:
Поля
Имя |
Тип |
Описание |
Данные панели. |
||
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от IControl. |
||
Состояние панели. Имена полей, доступных через метод data.Manager.get:
|
События
Имя |
Описание |
Панель пробок свернута. Экземпляр класса Event. |
|
Панель пробок развернута. Экземпляр класса Event. |
|
Пробки скрыты. Экземпляр класса Event. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
|
Сменился ключ провайдера. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
|
|
Показаны пробки. Экземпляр класса Event. |
Методы
Имя |
Возвращает |
Описание |
collapse() |
Свернуть панель пробок. |
|
expand() |
Развернуть панель пробок. |
|
getMap() |
Возвращает ссылку на карту. |
|
IControlParent|null |
Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IControl. |
|
getProvider([key]) |
Возвращает экземпляр провайдера пробок. |
|
Скрыть провайдер пробок с карты. |
||
Boolean |
Возвращает признак, развернута ли панель. |
|
Boolean |
Возвращает признак, показан ли провайдер пробок на карте. |
|
Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IControl. |
||
Показать провайдер пробок на карте. |
Описание полей
data
{data.Manager} data
Данные панели.
state
{data.Manager} state
Состояние панели. Имена полей, доступных через метод data.Manager.get:
- trafficShown - признак, показан ли на карте провайдер пробок;
- providerKey - ключ провайдера, который показывает панель. Может принимать значения 'traffic#actual' или 'traffic#archive';
- expanded - признак, развернута ли панель.
Описание событий
collapse
Панель пробок свернута. Экземпляр класса Event.
expand
Панель пробок развернута. Экземпляр класса Event.
hidetraffic
Пробки скрыты. Экземпляр класса Event.
providerkeychange
Сменился ключ провайдера. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
- newProviderKey - новое значение ключа провайдера;
- oldProviderKey – старое значение ключа.
showtraffic
Показаны пробки. Экземпляр класса Event.
Описание методов
collapse
{} collapse()
Свернуть панель пробок.
expand
{} expand()
Развернуть панель пробок.
getMap
{Map} getMap()
Возвращает ссылку на карту.
getProvider
{ITrafficProvider} getProvider([key])
Возвращает экземпляр провайдера пробок.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: String Ключ провайдера информации о пробках. Список доступных ключей:
|
Пример:
// Добавим на карту контрол пробок.
map.controls.add('trafficControl');
// Провайдер пробок "сейчас" при открытии будет показывать слой дорожных событий.
map.controls.get('trafficControl').getProvider('traffic#actual').state.set('infoLayerShown', true);
hideTraffic
{} hideTraffic()
Скрыть провайдер пробок с карты.
isExpanded
{Boolean} isExpanded()
Возвращает признак, развернута ли панель.
isTrafficShown
{Boolean} isTrafficShown()
Возвращает признак, показан ли провайдер пробок на карте.
showTraffic
{} showTraffic()
Показать провайдер пробок на карте.