YMaps.RouterEditor.RouterModel

Внимание

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

Модель для хранения результата обращения к маршрутизатору.

При установке новых данных генерируется событие RouterResultChange.

Конструктор

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

События

Имя Описание
RouterResultChange Возникает при установке нового результата маршрутизатора. В обработчик события передается результат работы маршрутизатора (см. YMaps.RouterEditor.RouterResult).

Методы

Имя Возвращает Описание
getRouteProvider() YMaps.RouterEditor.IRouteProvider Получает провайдера для построения маршрута.
getRouterResult() YMaps.RouterEditor.RouterResult Получает результат работы маршрутизатора.
setRouterResult(result) Устанавливает результат работы маршрутизатора.

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

YMaps.RouterEditor.RouterModel(options)

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

Параметры:

Имя Тип Необязательный По умолчанию Описание
options Object Опции.
options.routeProvider Object String

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

RouterResultChange

RouterResultChange

Возникает при установке нового результата маршрутизатора. В обработчик события передается результат работы маршрутизатора (см. YMaps.RouterEditor.RouterResult).

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

getRouteProvider

{YMaps.RouterEditor.IRouteProvider} getRouteProvider()

Получает провайдера для построения маршрута.

Возвращает:

Тип Описание
YMaps.RouterEditor.IRouteProvider Провайдер маршрутов.

getRouterResult

{YMaps.RouterEditor.RouterResult} getRouterResult()

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

Возвращает:

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

setRouterResult

setRouterResult(result)

Устанавливает результат работы маршрутизатора.

Параметры:

Имя Тип Описание
result YMaps.RouterEditor.RouterResult Результат работы маршрутизатора.
Предыдущая
YMaps.RouterEditor.RouteProviders
Следующая
YMaps.RouterEditor.RouterResult