multiRouter.MultiRouteModel

Расширяет IEventEmitter.

Модель данных мультимаршрута.

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

Конструктор

multiRouter.MultiRouteModel(referencePoints[, params])

Создает модель данных мультимаршрута.

Параметры:

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

Тип: IMultiRouteReferencePoint[]

Описание опорных точек мультимаршрута.

params

Тип: IMultiRouteParams

Параметры маршрутизации.

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

Пример:

// Создаем модель мультимаршрута.
var multiRouteModel = new ymaps.multiRouter.MultiRouteModel(['Москва', 'Тверь', 'Питер'], {
    avoidTrafficJams: true,
    viaIndexes: [1]
});

// Создаем отображение мультимаршрута на основе модели.
var multiRouteView = new ymaps.multiRouter.MultiRoute(multiRouteModel);
myMap.geoObjects.add(multiRouteView);

// Подписываемся на события модели мультимаршрута.
multiRouteView.model.events
    .add("requestsuccess", function (event) {
        var routes = event.get("target").getRoutes();
        console.log("Найдено маршрутов: " + routes.length);
        for (var i = 0, l = routes.length; i < l; i++) {
            console.log("Длина маршрута " + (i + 1) + ": " + routes[i].properties.get("distance").text);
        }
    })
    .add("requestfail", function (event) {
        console.log("Ошибка: " + event.get("error").message);
    });

Поля

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

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

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

properties data.Manager

Данные мультимаршрута.

События

Имя Описание
requestcancel
Запрос за данными отменен. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • referencePoints: Object[] - массив, описывающий множество опорных точек;
  • params: Object – параметры маршрутизации.
requestchange
Изменились опорные данные модели мультимаршрута (опорные точки, либо параметры маршрутизации). В результате формируется новый запрос за данными к сервису маршрутизации. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • referencePoints: Object[] - массив, описывающий множество опорных точек;
  • params: Object - параметры маршрутизации.
  • oldReferencePoints: Object[] – массив, описывающий предыдущее множество опорных точек;
  • oldParams: Object - предыдущие параметры маршрутизации.
requestfail
Запрос за данными завершился с ошибкой. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • error: Error – объект ошибки.
requestsend
Отправлен новый запрос за данными модели мультимаршрута. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • referencePoints: Object[] - массив, описывающий множество опорных точек;
  • params: Object – параметры маршрутизации.
requestsuccess
Запрос за данными завершился успешно, модель данных обновлена. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • init: Boolean – признак инициализирующего запроса;
  • rough: Boolean - признак промежуточного запроса (используется для оптимизации размера ответа сервера при редактировании маршрута);
  • wayPointsChange: Boolean - признак изменений в наборе путевых точек;
  • viaPointsChange: Boolean - признак изменений в наборе транзитных точек;
  • routesChange: Boolean - признак изменений в наборе маршрутов.

Методы

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

Уничтожает модель.

getAllPoints()

(multiRouter.WayPointModel|multiRouter.ViaPointModel)[]

Возвращает объединенный массив моделей транзитных и путевых точек в порядке, соответствующем порядку следования соответствующих опорных точек.

getJson()

Object

Возвращает JSON-данные модели мультимаршрута.

getParams()

IMultiRouteParams

Возвращает объект, описывающий текущие значения параметров маршрутизации.

getPoints()

(multiRouter.WayPointModel|multiRouter.ViaPointModel)[]

Устаревшее название метода multiRouter.MultiRouteModel.getAllPoints. Не рекомендуется к использованию.

getReferencePointIndexes()

Object

Возвращает объект, содержащий следующие поля:
  • way: Integer[] - индексы опорных точек, соответствующие множеству путевых точек модели;
  • via: Integer[] - индексы опорных точек, соответствующие множеству транзитных точек модели.
getReferencePoints()

IMultiRouteReferencePoint[]

Возвращает массив опорных точек мультимаршрута.

getRoutes()

multiRouter.driving.RouteModel[]|multiRouter.masstransit.RouteModel[]

Возвращает массив моделей дочерних маршрутов.

getViaPoints()

multiRouter.ViaPointModel[]

Возвращает массив моделей дочерних транзитных точек.

getWayPoints()

multiRouter.WayPointModel[]

Возвращает массив моделей дочерних путевых точек.

setParams(params[, extend[, clearRequests]])

Задает параметры маршрутизации.

setReferencePoints(referencePoints[, viaIndexes[, clearRequests]])

Задает опорные точки мультимаршрута.

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

properties

{data.Manager} properties

Данные мультимаршрута.

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

requestcancel

Запрос за данными отменен. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • referencePoints: Object[] - массив, описывающий множество опорных точек;
  • params: Object – параметры маршрутизации.

requestchange

Изменились опорные данные модели мультимаршрута (опорные точки, либо параметры маршрутизации). В результате формируется новый запрос за данными к сервису маршрутизации. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • referencePoints: Object[] - массив, описывающий множество опорных точек;
  • params: Object - параметры маршрутизации.
  • oldReferencePoints: Object[] – массив, описывающий предыдущее множество опорных точек;
  • oldParams: Object - предыдущие параметры маршрутизации.

requestfail

Запрос за данными завершился с ошибкой. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • error: Error – объект ошибки.

requestsend

Отправлен новый запрос за данными модели мультимаршрута. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • referencePoints: Object[] - массив, описывающий множество опорных точек;
  • params: Object – параметры маршрутизации.

requestsuccess

Запрос за данными завершился успешно, модель данных обновлена. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • init: Boolean – признак инициализирующего запроса;
  • rough: Boolean - признак промежуточного запроса (используется для оптимизации размера ответа сервера при редактировании маршрута);
  • wayPointsChange: Boolean - признак изменений в наборе путевых точек;
  • viaPointsChange: Boolean - признак изменений в наборе транзитных точек;
  • routesChange: Boolean - признак изменений в наборе маршрутов.

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

destroy

{} destroy()

Уничтожает модель.

getAllPoints

Возвращает объединенный массив моделей транзитных и путевых точек в порядке, соответствующем порядку следования соответствующих опорных точек.

getJson

{Object} getJson()

Возвращает JSON-данные модели мультимаршрута.

getParams

{IMultiRouteParams} getParams()

Возвращает объект, описывающий текущие значения параметров маршрутизации.

getPoints

Устаревшее название метода multiRouter.MultiRouteModel.getAllPoints. Не рекомендуется к использованию.

Возвращает объединенный массив моделей транзитных и путевых точек в порядке, соответствующем порядку следования соответствующих опорных точек.

getReferencePointIndexes

{Object} getReferencePointIndexes()
Возвращает объект, содержащий следующие поля:
  • way: Integer[] - индексы опорных точек, соответствующие множеству путевых точек модели;
  • via: Integer[] - индексы опорных точек, соответствующие множеству транзитных точек модели.

getReferencePoints

{IMultiRouteReferencePoint[]} getReferencePoints()

Возвращает массив опорных точек мультимаршрута.

getRoutes

Возвращает массив моделей дочерних маршрутов.

getViaPoints

{multiRouter.ViaPointModel[]} getViaPoints()

Возвращает массив моделей дочерних транзитных точек.

getWayPoints

{multiRouter.WayPointModel[]} getWayPoints()

Возвращает массив моделей дочерних путевых точек.

setParams

{} setParams(params[, extend[, clearRequests]])

Задает параметры маршрутизации.

Параметры:

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

Тип: IMultiRouteParams

Параметры маршрутизации.

extend false

Тип: Boolean

Позволяет изменить лишь часть параметров, а значения не переданных оставить прежним.

clearRequests false

Тип: Boolean

Позволяет очистить очередь предыдущих запросов к серверу.

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

setReferencePoints

{} setReferencePoints(referencePoints[, viaIndexes[, clearRequests]])

Задает опорные точки мультимаршрута.

Параметры:

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

Тип: IMultiRouteReferencePoint[]

Массив опорных точек.

viaIndexes

Тип: Integer[]

Индексы транзитных точек в массиве опорных точек.

clearRequests false

Тип: Boolean

Позволяет очистить очередь предыдущих запросов к серверу.

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