--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.ru/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/control.TrafficControl.md - https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt # control.TrafficControl Расширяет [IControl](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md), [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md). Панель управления пробками на карте. [Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary) ## Конструктор {#constructor-summary} ```javascript control.TrafficControl([parameters]) ``` **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`parameters`](#param-parameters) | — | Тип: Object Параметры элемента управления. || || [`parameters.options`](#param-parameters.options) | — | Тип: Object Опции элемента управления. || || [`parameters.options.adjustMapMargin`](#param-parameters.options.adjustMapMargin) | false | Тип: Boolean Регистрирует ли элемент управления свои размеры в менеджере отступов карты [map.margin.Manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Manager.md). || || [`parameters.options.collapseOnBlur`](#param-parameters.options.collapseOnBlur) | true | Тип: Boolean Флаг, разрешающий сворачиваение панели при потере фокуса на элементе управления. Например при клике на документ. || || [`parameters.options.float`](#param-parameters.options.float) | "right" | Тип: String Сторона, по которой нужно выравнивать элемент управления. Может принимать три значения: "left", "right" или "none". При значении "left" или "right" элементы управления выстраиваются друг за другом, начиная от левого или правого края карты соответственно. При значении "none" элементы управления позиционируется только по значениям опций left, right, bottom, top относительно границ карты. Также смотрите описание опции position. || || [`parameters.options.floatIndex`](#param-parameters.options.floatIndex) | 100 | Тип: Number Приоритет расположения элемента управления. Элемент с максимальным приоритетом находится ближе к указанному в свойстве float краю карты. Не работает при float = "none". || || [`parameters.options.layout`](#param-parameters.options.layout) | — | Тип: Function\|String Макет элемента управления. В конструктор макета передается объект, содержащий поля: - control - ссылка на элемент управления; - options - менеджер опций элемента управления control.TrafficControl.options; - data — менеджер данных элемента управления [control.TrafficControl.data](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#data); - state — менеджер состояний элемента управления [control.TrafficControl.state](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#state); Макет меняет свой внешний вид на основе данных, состояния и опций элемента управления. Элемент управления, в свою очередь, реагирует на интерфейсные события макета и меняет значения полей [control.TrafficControl.state](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#state) в зависимости от полученных команд. (Тип: конструктор объекта с интерфейсом [ITrafficControlLayout](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ITrafficControlLayout.md) или ключ макета). || || [`parameters.options.maxWidth`](#param-parameters.options.maxWidth) | [26, 195, 195] | Тип: Number\|Number[] Максимальная ширина кнопки в различных состояниях. Если задано число, то считается, что элемент управления имеет одинаковые максимальные размеры во всех состояниях. Если задан массив, то он будет трактоваться как максимальная ширина в различных состояниях - от меньшего к большему. Количество доступных состояний задается в экземпляре класса [control.Manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.Manager.md) через опцию states. Этот класс обычно является полем [Map.controls](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md#controls). По умолчанию у элементов управления есть три состояния - ['small', 'medium', 'large']. || || [`parameters.options.position`](#param-parameters.options.position) | — | Тип: Object Объект, описывающий позицию элемента управления. При указании опции position значение опции float автоматически трактуется как "none". || || [`parameters.options.position.bottom`](#param-parameters.options.position.bottom) | 'auto' | Тип: Number\|String Положение относительно нижнего края карты. || || [`parameters.options.position.left`](#param-parameters.options.position.left) | 'auto' | Тип: Number\|String Положение относительно левого края карты. || || [`parameters.options.position.right`](#param-parameters.options.position.right) | 'auto' | Тип: Number\|String Положение относительно правого края карты. || || [`parameters.options.position.top`](#param-parameters.options.position.top) | 'auto' | Тип: Number\|String Положение относительно верхнего края карты. || || [`parameters.options.size`](#param-parameters.options.size) | 'auto' | Тип: String Параметр, отвечающий за внешний вид стандартного макета элемента управления пробками. Может принимать значения: - 'auto' — макет автоматически изменяет свой внешний вид в зависимости от размеров карты и от количества добавленных элементов управления; - 'small' - в макете кнопки отображается только иконка светофора, независимо от размера карты; - 'large' - в макете кнопки всегда отображается иконка сфетофора и текст, независимо от размера карты. || || [`parameters.options.visible`](#param-parameters.options.visible) | true | Тип: Boolean Признак того, что элемент управления отображается. || || [`parameters.state`](#param-parameters.state) | — | Тип: Object Состояние элемента управления. || || [`parameters.state.providerKey`](#param-parameters.state.providerKey) | 'traffic#actual' | Тип: String Ключ провайдера пробок, показываемых на карте. - 'traffic#actual' - пробки "сейчас" - 'traffic#archive' - пробки "обычно" || || [`parameters.state.trafficShown`](#param-parameters.state.trafficShown) | false | Тип: Boolean Показаны ли данные по пробкам на карте. || |# **Пример:** ```javascript // Добавление на карту элемента управления пробками // с включенными пробками "сейчас". var trafficControl = new ymaps.control.TrafficControl({state: {trafficShown: true}}); map.controls.add(trafficControl, {top: ``` ## Поля {#properties-summary} #| || **Имя** | **Тип** | **Описание** || || [data](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#data) | [data.Manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Данные панели. || || [events](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). || || [options](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#options) | [IOptionManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций. Унаследовано от [IControl](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#options). || || [state](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#state) | [data.Manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Состояние панели. Имена полей, доступных через метод data.Manager.get: - trafficShown - признак, показан ли на карте провайдер пробок; - providerKey - ключ провайдера, который показывает панель. Может принимать значения 'traffic#actual' или 'traffic#archive'; - expanded - признак, развернута ли панель. || - |# ## События {#events-summary} #| || **Имя** | **Описание** || || [collapse](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#event-collapse) | Панель пробок свернута. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). || || [expand](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#event-expand) | Панель пробок развернута. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). || || [hidetraffic](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#event-hidetraffic) | Пробки скрыты. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). || || [optionschange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта. Унаследовано от [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange). || || [parentchange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект. Поля данных: - oldParent - старый родитель; - newParent - новый родитель. Унаследовано от [IChild](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange). || || [providerkeychange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#event-providerkeychange) | Сменился ключ провайдера. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - newProviderKey - новое значение ключа провайдера; - oldProviderKey – старое значение ключа. || || [showtraffic](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#event-showtraffic) | Показаны пробки. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). || |# ## Методы {#methods-summary} #| || **Имя** | **Возвращает** | **Описание** || || [collapse](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#collapse)() | | Свернуть панель пробок. || || [expand](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#expand)() | | Развернуть панель пробок. || || [getMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#getMap)() | [Map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает ссылку на карту. || || [getParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#getParent)() | [IControlParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControlParent.md)\|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от [IControl](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#getParent). || || [getProvider](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#getProvider)(\[[key](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#getProvider-param-key)]) | [ITrafficProvider](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ITrafficProvider.md) | Возвращает экземпляр провайдера пробок. || || [hideTraffic](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#hideTraffic)() | | Скрыть провайдер пробок с карты. || || [isExpanded](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#isExpanded)() | Boolean | Возвращает признак, развернута ли панель. || || [isTrafficShown](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#isTrafficShown)() | Boolean | Возвращает признак, показан ли провайдер пробок на карте. || || [setParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent)([parent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от [IControl](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent). || || [showTraffic](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.TrafficControl.md#showTraffic)() | | Показать провайдер пробок на карте. || |# ## Описание полей {#field_detail} ### data {#data} ```javascript {data.Manager} data ``` Данные панели. ### state {#state} ```javascript {data.Manager} state ``` Состояние панели. Имена полей, доступных через метод data.Manager.get: - trafficShown - признак, показан ли на карте провайдер пробок; - providerKey - ключ провайдера, который показывает панель. Может принимать значения 'traffic#actual' или 'traffic#archive'; - expanded - признак, развернута ли панель. ## Описание событий {#event_detail} ### collapse {#collapse} Панель пробок свернута. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ### expand {#expand} Панель пробок развернута. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ### hidetraffic {#hidetraffic} Пробки скрыты. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ### providerkeychange {#providerkeychange} Сменился ключ провайдера. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - newProviderKey - новое значение ключа провайдера; - oldProviderKey – старое значение ключа. ### showtraffic {#showtraffic} Показаны пробки. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ## Описание методов {#method_detail} ### collapse {#collapse} ```javascript {} collapse() ``` Свернуть панель пробок. ### expand {#expand} ```javascript {} expand() ``` Развернуть панель пробок. ### getMap {#getMap} ```javascript {Map} getMap() ``` **Возвращает** ссылку на карту. ### getProvider {#getProvider} ```javascript {ITrafficProvider} getProvider([key]) ``` **Возвращает** экземпляр провайдера пробок. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`key`](#getProvider-param-key) | — | Тип: String Ключ провайдера информации о пробках. Список доступных ключей: - 'traffic#actual' - провайдер пробок "сейчас"; - 'traffic#archive' — провайдер пробок "обычно". Если параметр не передан, возвращается текущий провайдер. || |# **Пример:** ```javascript // Добавим на карту контрол пробок. map.controls.add('trafficControl'); // Провайдер пробок "сейчас" при открытии будет показывать слой дорожных событий. map.controls.get('trafficControl').getProvider('traffic#actual').state.set('infoLayerShown', true); ``` ### hideTraffic {#hideTraffic} ```javascript {} hideTraffic() ``` Скрыть провайдер пробок с карты. ### isExpanded {#isExpanded} ```javascript {Boolean} isExpanded() ``` **Возвращает** признак, развернута ли панель. ### isTrafficShown {#isTrafficShown} ```javascript {Boolean} isTrafficShown() ``` **Возвращает** признак, показан ли провайдер пробок на карте. ### showTraffic {#showTraffic} ```javascript {} showTraffic() ``` Показать провайдер пробок на карте.