YMaps.Traffic.Control

Расширяет YMaps.IControl.

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

Конструктор

Имя Описание
YMaps.Traffic.Control(options, state) Создает элемент управления "Пробки".

События

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

Методы

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

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

Из YMaps.IControl:
onAddToMap, onRemoveFromMap

Подробное описание конструктора

YMaps.Traffic.Control(options, state)

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

Пример:

// Добавляет на карту элемент управления "Пробки" и немедленно включает показ пробок и дорожных событий
// При наведении курсора на значок дорожного события изменяет форму курсора на 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 Опции элемента управления.
options.showInfoSwitcher Boolean false

true - показывать кнопку включения/выключения слоя дорожных событий, false - не показывать.

Примечание. Эта кнопка и слой дорожных событий в настоящее время показываются только для карты Санкт-Петербурга.
options.layerOptions Object Опции слоя пробок.
options.layerOptions.hasHint Boolean true true - показывать всплывающую подсказку со скоростью движения, false - не показывать.
options.layerOptions.hasBalloon Boolean true true - показывать балун с информацией о пробке по щелчку мыши, false - не показывать.
options.layerOptions.cursor YMaps.Cursor YMaps.Cursor.POINTER Тип курсора мыши над пробками. Значение YMaps.Cursor.INHERIT отменяет изменение курсора над пробками.
options.infoLayerOptions Object Опции слоя дорожных событий.
options.infoLayerOptions.hasHint Boolean true true - показывать всплывающую подсказку с типом события над значком дорожного события, false - не показывать.
options.infoLayerOptions.hasBalloon Boolean true true - показывать балун с информацией о дорожном событии по щелчку мыши, false - не показывать.
options.infoLayerOptions.cursor YMaps.Cursor YMaps.Cursor.POINTER Тип курсора мыши над значками дорожных событий. Значение YMaps.Cursor.INHERIT отменяет изменение курсора над дорожными событиями.
state Object Исходное состояние.
state.shown Boolean false true - элемент управления "Пробки" включен, false - выключен.
state.infoLayerShown Boolean false true - слой дорожных событий показывается, false - не показывается. Слой дорожных событий показывается только вместе со слоем пробок, показать его отдельно нельзя.

Подробное описание событий

Hide

Hide

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

InfoLayerHide

InfoLayerHide

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

InfoLayerShow

InfoLayerShow

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

OptionsChange

OptionsChange

Произошло изменение опций.

Show

Show

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

StateChange

StateChange

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

Update

Update

Произошло обновление информации о пробках.

Подробное описание методов

getMap

{YMaps.Map} getMap()

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

Возвращает:

Тип Описание
YMaps.Map Карту.

getOptions

{Object} getOptions()

Возвращает опции элемента управления. Описание опций см. в YMaps.Traffic.Control.setOptions.

Возвращает:

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

getState

{Object} getState()

Возвращает состояние элемента управления "Пробки". Описание возможных состояний см. в YMaps.Traffic.Control.setState.

Возвращает:

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

hide

hide()

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

isShown

{Boolean} isShown()

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

Возвращает:

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

setOptions

setOptions(options, restoreDefault)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
options Object Опции элемента управления.
options.showInfoSwitcher Boolean false

true - показывать кнопку включения/выключения слоя дорожных событий, false - не показывать.

Примечание. Эта кнопка и слой дорожных событий в настоящее время показываются только для карты Санкт-Петербурга.
options.layerOptions Object Опции слоя пробок.
options.layerOptions.hasHint Boolean true true - показывать всплывающую подсказку со скоростью движения, false - не показывать.
options.layerOptions.hasBalloon Boolean true true - показывать балун с информацией о пробке по щелчку мыши, false - не показывать.
options.layerOptions.cursor YMaps.Cursor YMaps.Cursor.POINTER Тип курсора мыши над пробками. Значение YMaps.Cursor.INHERIT отменяет изменение курсора над пробками.
options.infoLayerOptions Object Опции слоя дорожных событий.
options.infoLayerOptions.hasHint Boolean true true - показывать всплывающую подсказку с типом события над значком дорожного события, false - не показывать.
options.infoLayerOptions.hasBalloon Boolean true true - показывать балун с информацией о дорожном событии по щелчку мыши, false - не показывать.
options.infoLayerOptions.cursor YMaps.Cursor YMaps.Cursor.POINTER Тип курсора мыши над значками дорожных событий. Значение YMaps.Cursor.INHERIT отменяет изменение курсора над дорожными событиями.
restoreDefault Boolean false true - восстановить значения по умолчанию для незаданных опций, false - не устанавливать.

setState

setState(state, restoreDefault)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
state Object Новое состояние.
state.shown Boolean false true - слой пробок показан на карте, кнопка пробок развернута; false - слой пробок убран с карты, кнопка пробок свернута.
state.infoLayerShown Boolean false true - показан слой дорожных событий; false - скрыт.
restoreDefault Boolean false true - восстановить значения по умолчанию для незаданных параметров состояния, false - не изменять значения незаданных параметров.

show

show()

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

update

update()

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