IRoutePanel

Расширяет IEventEmitter.

Интерфейс панели маршрута.

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

Конструктор

IRoutePanel()

Поля

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

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

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

options IOptionManager
Менеджер опций. Названия опций:
  • allowSwitch: Boolean = true – показать на панели кнопку, позволяющую менять местами начальную и конечную точки маршрута;
  • reverseGeocoding: Boolean = true – включить ли обратное геокодирование при построение маршрута;
  • adjustMapMargin: Boolean = false – будет ли панель маршрута регистрировать свои размеры в map.margin.Manager.
  • types: Object = { auto: true, masstransit: true, pedestrian: true, taxi: false } – типы маршрутизации, которые будут доступны для выбора пользователю. При изменении опции возможных типов маршрута, текущий выбранный тип автоматически меняется. Например, если был выбран пешеходный маршрут, а после этого вебмастер разрешил только автомобильные и на общественном транспорте, то автоматически выберется автомобильный. Доступные типы маршрутизации отображаются в панели только в том случае, если задано два или более типа.
state IDataManager
Менеджер состояний. Названия состояний:
  • type: String – тип маршрутизации IMultiRouteParams.routingMode;
  • fromEnabled: Boolean – включить возможность задавать пункт отправления в поле ввода;
  • from: String – адрес или координаты пункта отправления;
  • toEnabled: Boolean – включить возможность задавать пункт назначения в поле ввода;
  • to: String – адрес или координаты пункта назначения.

События

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

Зависимости панели не загружены.

enable

Панель маршрутизации и ее зависимости загружены и готовы к использованию.

Методы

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

Загружает все зависимости панели.

geolocate(name)

vow.Promise

Задать местоположение пользователя в качестве начальной или конечной точки маршрута.

getRoute()

multiRouter.MultiRoute

Внимание. Данный метод является устаревшим. См. IRoutePanel.getRouteAsync.

Возвращает построенный маршрут.

getRouteAsync()

vow.Promise.<multiRouter.MultiRoute>

Возвращает vow.Promise, который будет разрешен построенным маршрутом. Promise отклоняется при возникновении ошибки.

isEnable()

Boolean

Возвращает true, если панель полностью загружена, false – иначе.

switchPoints()

Меняет местами начальную и конечную точки маршрута. Изменения автоматически отобразятся в полях ввода на панели маршрута.

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

options

{IOptionManager} options
Менеджер опций. Названия опций:
  • allowSwitch: Boolean = true – показать на панели кнопку, позволяющую менять местами начальную и конечную точки маршрута;
  • reverseGeocoding: Boolean = true – включить ли обратное геокодирование при построение маршрута;
  • adjustMapMargin: Boolean = false – будет ли панель маршрута регистрировать свои размеры в map.margin.Manager.
  • types: Object = { auto: true, masstransit: true, pedestrian: true, taxi: false } – типы маршрутизации, которые будут доступны для выбора пользователю. При изменении опции возможных типов маршрута, текущий выбранный тип автоматически меняется. Например, если был выбран пешеходный маршрут, а после этого вебмастер разрешил только автомобильные и на общественном транспорте, то автоматически выберется автомобильный. Доступные типы маршрутизации отображаются в панели только в том случае, если задано два или более типа.

state

{IDataManager} state
Менеджер состояний. Названия состояний:
  • type: String – тип маршрутизации IMultiRouteParams.routingMode;
  • fromEnabled: Boolean – включить возможность задавать пункт отправления в поле ввода;
  • from: String – адрес или координаты пункта отправления;
  • toEnabled: Boolean – включить возможность задавать пункт назначения в поле ввода;
  • to: String – адрес или координаты пункта назначения.

Описание событий

disable

Зависимости панели не загружены.

enable

Панель маршрутизации и ее зависимости загружены и готовы к использованию.

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

enable

{} enable()

Загружает все зависимости панели.

geolocate

{vow.Promise} geolocate(name)

Задать местоположение пользователя в качестве начальной или конечной точки маршрута.

Возвращает объект-promise. см. geolocation.

Параметры:

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

Тип: String

В качестве какой точки маршрута (начальной или конечной) нужно использовать местоположение пользователя. Принимает значение 'from' или 'to'.

* Обязательный параметр/опция.

getRoute

Данный метод является устаревшим. See IRoutePanel.getRouteAsync.

Возвращает построенный маршрут.

getRouteAsync

Возвращает vow.Promise, который:

  • будет разрешен построенным маршрутом (объектом multiRouter.MultiRoute),
  • либо отклонен с ошибкой.

isEnable

{Boolean} isEnable()

Возвращает true, если панель полностью загружена, false – иначе.

switchPoints

{} switchPoints()

Меняет местами начальную и конечную точки маршрута. Изменения автоматически отобразятся в полях ввода на панели маршрута.