traffic.provider.Forecast

Расширяет ITrafficProvider .

Провайдер прогноза пробок. Доступен в хранилище провайдеров под ключом 'traffic#forecast'.

Конструктор | Поля | События | Методы

Конструктор

traffic.provider.Forecast([options[, state]])

Создает провайдер прогноза пробок.

Параметры:

Параметр Значение по умолчанию Описание
options

Тип: Object

Опции провайдера. Опции для слоев провайдера задаются через опции глобальной коллекции слоев Map.layers .
  • Опции для картиночного слоя Layer задаются с префиксом 'trafficImage';
  • Опции для картиночного слоя hotspot.Layer задаются с префиксом 'trafficJam';
options.autoUpdate true

Тип: Boolean

Флаг, включающий автоматическое обновление данных о пробках. Автоматическое обновление происходит только в том случае, если на карте каждые 4 минуты возникает событие mousemove. Если событие не возникает, пробки перестают обновляться до появления нового события.

state

Тип: Object

Состояние провайдера.

state.timeOffset 900

Тип: Number

временной интервал между текущим временем и временем прогноза. Измеряется в секундах и кратен 15 минутам (900 секундам).
// Создадим провайдер пробок с прогнозом на полчаса вперед
// и разместим его на карте.
var forecastProvider = new ymaps.traffic.provider.Forecast({}, {timeOffset: 30 * 60});
forecastProvider.setMap(myMap);

// Запретим показ всплывающих подсказок для пробок.
myMap.layers.options.set({
    // Название опции сформировано из опции хотспотного слоя
    // 'openHintOnHover' путем добавления префикса 'trafficJam'.
    trafficJamOpenHintOnHover: false
});
// ...
// Удаление провайдера с карты.
forecastProvider.setMap(null);

Поля

Имя Тип Описание
events IEventManager

Менеджер событий.

Унаследовано от IEventEmitter .

options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable .

state data.Manager
Состояние провайдера. Имена полей, доступных через метод data.Manager.get:
  • isInited - признак, готов ли провайдер предоставлять данные;
  • timestamp - текущее время в формате unix timestamp в секундах;
  • localtime - локальное время, для которого сервер в текущий момент отдает данные, в формате 'ЧЧ:ММ';
  • level - уровень загруженности дорог в баллах - от 0 до 10.
  • timeOffset - временной интервал между текущим временем и временем прогноза. Измеряется в секундах и кратен 15 минутам (900 секундам)
  • isotime - строка, содержащая текущую дату в формате "YYYY-MM-DDThh:mm:ss±hhmm".

События

Имя Описание
optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable .

Методы

Имя Возвращает Описание
getMap ()

Map |null

Возвращает ссылку на карту.

Унаследован от ITrafficProvider .

getTime ()

Object|null

Возвращает время, которое пользователь видит в элементе управления пробками. Объект содержит следующие поля:
  • dayOfWeek — сокращенное название дня недели ('mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun');
  • hours — часы;
  • minutes - минуты.
Если центр карты находится в точке, для которой не удается опеределить часовой пояс, функция возвращает null - если мы не знаем, в каком часовом поясе находимся, мы не можем узнать местное время.
setMap (Reference)

Описание полей

state

{
              data.Manager
            } state
Состояние провайдера. Имена полей, доступных через метод data.Manager.get:
  • isInited - признак, готов ли провайдер предоставлять данные;
  • timestamp - текущее время в формате unix timestamp в секундах;
  • localtime - локальное время, для которого сервер в текущий момент отдает данные, в формате 'ЧЧ:ММ';
  • level - уровень загруженности дорог в баллах - от 0 до 10.
  • timeOffset - временной интервал между текущим временем и временем прогноза. Измеряется в секундах и кратен 15 минутам (900 секундам)
  • isotime - строка, содержащая текущую дату в формате "YYYY-MM-DDThh:mm:ss±hhmm".

Описание методов

getTime

{Object|null} getTime()
Возвращает время, которое пользователь видит в элементе управления пробками. Объект содержит следующие поля:
  • dayOfWeek — сокращенное название дня недели ('mon', 'tue', 'wed', 'thu', 'fri', 'sat', 'sun');
  • hours — часы;
  • minutes - минуты.
Если центр карты находится в точке, для которой не удается опеределить часовой пояс, функция возвращает null - если мы не знаем, в каком часовом поясе находимся, мы не можем узнать местное время.