route

Статическая функция.

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

Returns объект-promise, который подтверждается при успешном построении маршрута и получает в качестве параметра экземпляр класса router.Route, соответствующий построенному маршруту.

{ util.Promise } route(points[, options])

Параметры:

Параметр	Значение по умолчанию	Описание
`points`*	—	Тип: Object[] Набор точек, через которые должен проходить маршрут. В массиве могут быть заданы строки - "Москва", координаты точки - [30, 50] и объекты, описывающие точку, - { type: 'viaPoint', point: 'Москва' } или { type: 'wayPoint', point: [30, 50] }. Через тип 'viaPoint' обозначается транзитная точка, т.е. точка, через которую нужно проехать без остановки.
`options`	—	Тип: Object Опции построения маршрута.
`options.avoidTrafficJams`	false	Тип: Boolean true - строить маршрут с учетом пробок, false - без учета пробок. При использовании опции учитывайте, что объезд пробок не всегда возможен.
`options.boundedBy`	—	Тип: Number[][] Область на карте, где предположительно находятся искомые объекты. Используется, если точки маршрута заданы почтовым адресом, а не координатами.
`options.mapStateAutoApply`	false	Тип: Boolean Флаг, позволяющий автоматически установить центр и коэффициент масштабирования карты так, чтобы построенный маршрут был виден целиком.
`options.searchCoordOrder`	—	Тип: String Определяет каким образом нужно интрепретировать координаты в запросе. Используется, если точки маршрута заданы почтовым адресом, а не координатами.
`options.strictBounds`	false	Тип: Boolean Искать только внутри области, заданной опцией boundedBy.

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

Пример:

// Строим маршрут из Королева в Красногорск через Химки и Мытищи, где Мытищи - транзитная точка.
// Красногорск зададим координатами.
ymaps.route([
     'Королев',
     { type: 'viaPoint', point: 'Мытищи' },
     'Химки',
     { type: 'wayPoint', point: [55.811511, 37.312518] }
 ], {
     mapStateAutoApply: true
 }).then(function (route) {
     route.getPaths().options.set({
         // в балуне выводим только информацию о времени движения с учетом пробок
         balloonContentBodyLayout: ymaps.templateLayoutFactory.createClass('$[properties.humanJamsTime]'),
         // можно выставить настройки графики маршруту
         strokeColor: '0000ffff',
         opacity: 0.9
     });
     // добавляем маршрут на карту
     map.geoObjects.add(route);
 });

Была ли статья полезна?

Rectangle

router.Editor