new Routing(params)
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
params |
object | опции создания экземпляра класса Properties
|
- Source:
Methods
-
addLocation(data)
Добавляет маршуртную точку
. -
Добавляет маршуртную точку
Parameters:
Name Type Description dataRoutingLocation - Source:
-
<async> calc(params)
Метод, вычисляющий маршрут
. -
Метод, вычисляющий маршрут
Parameters:
Name Type Description paramsobject опции поиска
Properties
Name Type Description locationsarray массив путевых точек
- Source:
Returns:
- Type
- Promise.<*>
-
emit(eventName, context)
Инициация события с контекстом
. -
Инициация события с контекстом
Parameters:
Name Type Description eventNameимя события
contextконтекст события
- Source:
-
getLocations()
Возврашает текущий набор маршуртных точек
. -
Возврашает текущий набор маршуртных точек
- Source:
Returns:
- Type
- Array | *
-
off(eventName)
Выключение подписки на событие
. -
Выключение подписки на событие
Parameters:
Name Type Description eventNameимя события
- Source:
-
on(eventName, listener)
Подписка на события
. -
Подписка на события
Parameters:
Name Type Description eventNameимя события
listenercallback
- Source:
-
removeLocation(index)
Удаляет маршрутную точку по ее индексу
. -
Удаляет маршрутную точку по ее индексу
Parameters:
Name Type Description index- Source:
-
setOptions(params)
-
Parameters:
Name Type Description paramsobject Properties
Name Type Description mapMap ссылка на экземпляр карты
- Source:
-
start()
Запуск работы модуля маршрутизации
. -
Запуск работы модуля маршрутизации
- Source:
-
stop()
Остановка работы модуля
. -
Остановка работы модуля
- Source:
Events
-
route-calculated
Событие возникает перерасчете маршрута
. -
Событие возникает перерасчете маршрута
- Source:
-
routing-started
Cобытие, возникающее при старте (инициализации) модуля роутинга
. -
Cобытие, возникающее при старте (инициализации) модуля роутинга
- Source:
Returns:
- Type
- object