YMaps.RouterEditor.RouterResultHelper

Внимание. Маршрутизация доступна только в актуальных версиях API.

Как перейти на API 2.1

Хелпер для работы с результатом маршрутизатора YMaps.RouterEditor.RouterResult.

Конструктор

Имя Описание
YMaps.RouterEditor.RouterResultHelper(routerResult) Создает экземпляр хелпера.

Методы

Имя Возвращает Описание
getBounds() YMaps.GeoBounds Получает ограничивающую область для всех маршрутов.
getDistance() Number Получает общую протяженность всех маршрутов.
getDuration() Number Получает общую продолжительность всех маршрутов.
getNumRoutes() Number Получает общее число маршрутов.
getNumWayPoints() Number Получает число точек, между которыми прокладывается маршрут.
getRoute(index) YMaps.Route Получает маршрут с заданным индексом.
getRouterRequest() Object Получает исходный запрос к маршрутизатору (см. YMaps.RouterEditor.IRouteProvider.route).
getRouterResult() YMaps.RouterEditor.RouterResult Получает результат маршрутизатора.
getWayPoint(index) Object Получает информацию о точке маршрута.

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

YMaps.RouterEditor.RouterResultHelper(routerResult)

Создает экземпляр хелпера.

Параметры:

Имя Тип Описание
routerResult YMaps.RouterEditor.RouterResult Результат маршрутизатора.

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

getBounds

{YMaps.GeoBounds} getBounds()

Получает ограничивающую область для всех маршрутов.

Возвращает:

Тип Описание
YMaps.GeoBounds Ограничивающая область для всех маршрутов.

getDistance

{Number} getDistance()

Получает общую протяженность всех маршрутов.

Возвращает:

Тип Описание
Number Общая протяженность всех маршрутов.

getDuration

{Number} getDuration()

Получает общую продолжительность всех маршрутов.

Возвращает:

Тип Описание
Number Общая продолжительность всех маршрутов.

getNumRoutes

{Number} getNumRoutes()

Получает общее число маршрутов.

Возвращает:

Тип Описание
Number Общее число маршрутов.

getNumWayPoints

{Number} getNumWayPoints()

Получает число точек, между которыми прокладывается маршрут.

Возвращает:

Тип Описание
Number Число точек, между которыми прокладывается маршрут.

getRoute

{YMaps.Route} getRoute(index)

Получает маршрут с заданным индексом.

Параметры:

Имя Тип Описание
index Number Индекс маршрута.

Возвращает:

Тип Описание
YMaps.Route Маршрут.

getRouterRequest

{Object} getRouterRequest()

Получает исходный запрос к маршрутизатору (см. YMaps.RouterEditor.IRouteProvider.route).

Возвращает:

Тип Описание
Object Исходный запрос к маршрутизатору (см. YMaps.RouterEditor.IRouteProvider.route).

getRouterResult

Получает результат маршрутизатора.

Возвращает:

Тип Описание
YMaps.RouterEditor.RouterResult Результат маршрутизатора.

getWayPoint

{Object} getWayPoint(index)

Получает информацию о точке маршрута.

Параметры:

Имя Тип Описание
index Number Индекс точки.

Возвращает:

Тип Описание
Object Информация о точке маршрута (см. YMaps.RouterEditor.RouterResult).