---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/traffic.control.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.Traffic.Control

Расширяет [YMaps.IControl](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md).

Элемент управления "Пробки". Позволяет отображать на карте кнопку "Пробки" и показывать/скрывать слои пробок и дорожных событий.

## Конструктор

Имя | Описание
----- | -----
[YMaps.Traffic.Control](traffic.control.md#constructor)(options, state) | Создает элемент управления "Пробки".

## События

Имя | Описание
----- | -----
[Hide](traffic.control.md#event-Hide) | Элемент управления выключен.
[InfoLayerHide](traffic.control.md#event-InfoLayerHide) | Слой дорожных событий скрыт.
[InfoLayerShow](traffic.control.md#event-InfoLayerShow) | Слой дорожных событий показан.
[OptionsChange](traffic.control.md#event-OptionsChange) | Произошло изменение опций.
[Show](traffic.control.md#event-Show) | Элемент управления включен.
[StateChange](traffic.control.md#event-StateChange) | Произошло изменение состояния: включен (либо выключен) элемент управления, включен (либо выключен) слой дорожных событий.
[Update](traffic.control.md#event-Update) | Произошло обновление информации о пробках.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getMap](traffic.control.md#getMap)() | [YMaps.Map](map.md) | Возвращает карту, на которую в данный момент добавлен элемент управления, или null
[getOptions](traffic.control.md#getOptions)() | Object | Возвращает опции элемента управления. Описание опций см. в [YMaps.Traffic.Control.setOptions](traffic.control.md#setOptions).
[getState](traffic.control.md#getState)() | Object | Возвращает состояние элемента управления "Пробки". Описание возможных состояний см. в [YMaps.Traffic.Control.setState](traffic.control.md#setState).
[hide](traffic.control.md#hide)() |  | Выключает элемент управления, скрывает слои пробок и дорожных событий.
[isShown](traffic.control.md#isShown)() | Boolean | Возвращает состояние элемента управления.
[setOptions](traffic.control.md#setOptions)(options, restoreDefault) |  | Устанавливает опции элемента управления.
[setState](traffic.control.md#setState)(state, restoreDefault) |  | Задает состояние элемента управления "Пробки".
[show](traffic.control.md#show)() |  | Включает элемент управления, показывает слой пробок (и, опционально, слой дорожных событий) на карте.
[update](traffic.control.md#update)() |  | Обновляет текущее состояние пробок.

## Наследуемые методы


Из [YMaps.IControl](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md): 
: [onAddToMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md#onAddToMap), [onRemoveFromMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md#onRemoveFromMap)

## Подробное описание конструктора {#constructor}

```javascript
YMaps.Traffic.Control(options, state)
```

Создает элемент управления "Пробки".

**Пример:**

```javascript
// Добавляет на карту элемент управления "Пробки" и немедленно включает показ пробок и дорожных событий
// При наведении курсора на значок дорожного события изменяет форму курсора на help.
var map = new YMaps.Map(YMaps.jQuery('#YMapsID')[0]),
    traffic = new YMaps.Traffic.Control({ // Настройки элемента управления
                showInfoSwitcher: true,   // Показать в кнопке флажок "Дорожные события"
        infoLayerOptions: { // Опции слоя дорожных событий
            cursor: YMaps.Cursor.HELP
        }
    }, { // Начальное состояние элемента управления
        shown: true,                       // Немедленно включить показ пробок
        infoLayerShown: true // Показывать слой дорожных событий
    });
     // Выставляет центр карты в центр Санкт-Петербурга
map.setCenter(new YMaps.GeoPoint(30.313,59.939), 9);
     // Добавляет элемент управления "Пробки" на карту
map.addControl(traffic);
```

**Параметры:**

#|
|| **Имя** | **Тип** | **Необязательный** | **По умолчанию** | **Описание** ||
||`options` | Object | ![](../_images/check.png) |  | Опции элемента управления.||
||`options.showInfoSwitcher` | Boolean | ![](../_images/check.png) | false | true - показывать кнопку включения/выключения слоя дорожных событий, false - не показывать.


{% note info %}

Эта кнопка и слой дорожных событий в настоящее время показываются только для карты Санкт-Петербурга.

{% endnote %}||
||`options.layerOptions` | Object | ![](../_images/check.png) |  | Опции слоя пробок.||
||`options.layerOptions.hasHint` | Boolean | ![](../_images/check.png) | true | true - показывать всплывающую подсказку со скоростью движения, false - не показывать.||
||`options.layerOptions.hasBalloon` | Boolean | ![](../_images/check.png) | true | true - показывать балун с информацией о пробке по щелчку мыши, false - не показывать.||
||`options.layerOptions.cursor` | [YMaps.Cursor](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/cursor.md) | ![](../_images/check.png) | YMaps.Cursor.POINTER | Тип курсора мыши над пробками. Значение [YMaps.Cursor.INHERIT](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/cursor.md#INHERIT) отменяет изменение курсора над пробками.||
||`options.infoLayerOptions` | Object | ![](../_images/check.png) |  | Опции слоя дорожных событий.||
||`options.infoLayerOptions.hasHint` | Boolean | ![](../_images/check.png) | true | true - показывать всплывающую подсказку с типом события над значком дорожного события, false - не показывать.||
||`options.infoLayerOptions.hasBalloon` | Boolean | ![](../_images/check.png) | true | true - показывать балун с информацией о дорожном событии по щелчку мыши, false - не показывать.||
||`options.infoLayerOptions.cursor` | [YMaps.Cursor](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/cursor.md) | ![](../_images/check.png) | YMaps.Cursor.POINTER | Тип курсора мыши над значками дорожных событий. Значение [YMaps.Cursor.INHERIT](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/cursor.md#INHERIT) отменяет изменение курсора над дорожными событиями.||
||`state` | Object | ![](../_images/check.png) |  | Исходное состояние.||
||`state.shown` | Boolean | ![](../_images/check.png) | false | true - элемент управления "Пробки" включен, false - выключен.||
||`state.infoLayerShown` | Boolean | ![](../_images/check.png) | false | true - слой дорожных событий показывается, false - не показывается. Слой дорожных событий показывается только вместе со слоем пробок, показать его отдельно нельзя.||
|#

## Подробное описание событий {#event_detail}

### Hide {#Hide}

```javascript
Hide
```

Элемент управления выключен.
### InfoLayerHide {#InfoLayerHide}

```javascript
InfoLayerHide
```

Слой дорожных событий скрыт.
### InfoLayerShow {#InfoLayerShow}

```javascript
InfoLayerShow
```

Слой дорожных событий показан.
### OptionsChange {#OptionsChange}

```javascript
OptionsChange
```

Произошло изменение опций.
### Show {#Show}

```javascript
Show
```

Элемент управления включен.
### StateChange {#StateChange}

```javascript
StateChange
```

Произошло изменение состояния: включен (либо выключен) элемент управления, включен (либо выключен) слой дорожных событий.
### Update {#Update}

```javascript
Update
```

Произошло обновление информации о пробках.
## Подробное описание методов {#method_detail}

### getMap {#getMap}

```javascript
{YMaps.Map} getMap()
```

Возвращает карту, на которую в данный момент добавлен элемент управления, или null

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.Map](map.md) | Карту.

### getOptions {#getOptions}

```javascript
{Object} getOptions()
```

Возвращает опции элемента управления. Описание опций см. в [YMaps.Traffic.Control.setOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/traffic.control.md#setOptions).

**Возвращает:**

Тип | Описание
----- | -----
Object | Опции.

### getState {#getState}

```javascript
{Object} getState()
```

Возвращает состояние элемента управления "Пробки". Описание возможных состояний см. в [YMaps.Traffic.Control.setState](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/traffic.control.md#setState).

**Возвращает:**

Тип | Описание
----- | -----
Object | Состояние.

### hide {#hide}

```javascript
hide()
```

Выключает элемент управления, скрывает слои пробок и дорожных событий.
### isShown {#isShown}

```javascript
{Boolean} isShown()
```

Возвращает состояние элемента управления.

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - элемент управления включен, слой пробок показан; false - элемент управления выключен, слой пробок скрыт.

### setOptions {#setOptions}

```javascript
setOptions(options, restoreDefault)
```

Устанавливает опции элемента управления.

**Параметры:**

#|
|| **Имя** | **Тип** | **Необязательный** | **По умолчанию** | **Описание** ||
||`options` | Object | ![](../_images/check.png) |  | Опции элемента управления.||
||`options.showInfoSwitcher` | Boolean | ![](../_images/check.png) | false | true - показывать кнопку включения/выключения слоя дорожных событий, false - не показывать.


{% note info %}

Эта кнопка и слой дорожных событий в настоящее время показываются только для карты Санкт-Петербурга.

{% endnote %}

||
||`options.layerOptions` | Object | ![](../_images/check.png) |  | Опции слоя пробок.||
||`options.layerOptions.hasHint` | Boolean | ![](../_images/check.png) | true | true - показывать всплывающую подсказку со скоростью движения, false - не показывать.||
||`options.layerOptions.hasBalloon` | Boolean | ![](../_images/check.png) | true | true - показывать балун с информацией о пробке по щелчку мыши, false - не показывать.||
||`options.layerOptions.cursor` | [YMaps.Cursor](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/cursor.md) | ![](../_images/check.png) | YMaps.Cursor.POINTER | Тип курсора мыши над пробками. Значение [YMaps.Cursor.INHERIT](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/cursor.md#INHERIT) отменяет изменение курсора над пробками.||
||`options.infoLayerOptions` | Object | ![](../_images/check.png) |  | Опции слоя дорожных событий.||
||`options.infoLayerOptions.hasHint` | Boolean | ![](../_images/check.png) | true | true - показывать всплывающую подсказку с типом события над значком дорожного события, false - не показывать.||
||`options.infoLayerOptions.hasBalloon` | Boolean | ![](../_images/check.png) | true | true - показывать балун с информацией о дорожном событии по щелчку мыши, false - не показывать.||
||`options.infoLayerOptions.cursor` | [YMaps.Cursor](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/cursor.md) | ![](../_images/check.png) | YMaps.Cursor.POINTER | Тип курсора мыши над значками дорожных событий. Значение [YMaps.Cursor.INHERIT](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/cursor.md#INHERIT) отменяет изменение курсора над дорожными событиями.||
||`restoreDefault` | Boolean | ![](../_images/check.png) | false | true - восстановить значения по умолчанию для незаданных опций, false - не устанавливать.||
|#

### setState {#setState}

```javascript
setState(state, restoreDefault)
```

Задает состояние элемента управления "Пробки".

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`state` | Object |  |  | Новое состояние.
`state.shown` | Boolean | ![](../_images/check.png) | false | true - слой пробок показан на карте, кнопка пробок развернута; false - слой пробок убран с карты, кнопка пробок свернута.
`state.infoLayerShown` | Boolean | ![](../_images/check.png) | false | true - показан слой дорожных событий; false - скрыт.
`restoreDefault` | Boolean | ![](../_images/check.png) | false | true - восстановить значения по умолчанию для незаданных параметров состояния, false - не изменять значения незаданных параметров.

### show {#show}

```javascript
show()
```

Включает элемент управления, показывает слой пробок (и, опционально, слой дорожных событий) на карте.
### update {#update}

```javascript
update()
```

Обновляет текущее состояние пробок.