Маршрутизация
API Получение деталей маршрута
API Получение деталей маршрута — сервис для построения маршрутов на карте, позволяет проложить маршрут между известными точками для разных способов передвижения.
Доступны следующие типы маршрутизации:
- на легковом автомобиле;
- пешеходные;
- на общественном транспорте;
- на грузовом автомобиле.
Маршруты можно строить как с учетом пробок и дорожных событий, так и без.
Слой пробок реализуется классом YMapTrafficLayer, слой дорожных событий реализуется классом YMapTrafficEventsLayer.
Маршрутизация c использованием JS API методов
Маршрутизация c использованием JS API методов возможна с помощью функции ymaps3.route, которая принимает следующие опции:
|
Имя |
Тип |
Описание |
|
|
|
Избегайте платных дорог. Значение по умолчанию - |
|
|
|
Если указано, в свойствах будет возвращена ограничивающая рамка маршрута. Значение по умолчанию - |
|
|
|
Точки маршрута представлены координатами |
|
|
|
Параметры для грузового автомобиля (только для |
|
|
|
Тип маршрута. |
|
|
Текущий конфиг. |
Возвращает Promise<BaseRouteResponse[]>.
Методы
toRoute(): RouteFeature
Возвращает запрошенный маршрут в качестве RouteFeature.
toSteps(): RouteFeature[]
Возвращает запрошенный маршрут в качестве RouteFeature[].
Маршрутизация с помощью HTTP API
Маршрутизация без использования JS API методов возможна с помощью HTTP API получения деталей маршрута.
Если вам необходимо больше возможностей маршрутизации можно использовать HTTP API запрос напрямую к сервису:
-
Функцию
ymaps3.routeзаменяем наHTTP APIзапрос к сервису API получения деталей маршрута.Пример кода:
const httpApiUrl = 'https://api.routing.yandex.net/v2/route'; const queryString = new URLSearchParams({ apikey: 'YOUR_APIKEY', /* другие параметры HTTP API */ }).toString(); const fullUrl = `${url}?${queryString}`; // Получить ответ от HTTP API const response = await fetch(fullUrl);
Подробный пример (запрос API Матрицы расстояний)
Панель маршрутизации
В JS API реализован элемент управления «Панель маршрутизации» с помощью которого пользователи могут строить маршруты на карте.
Через панель можно:
- задать начальную и конечную точки маршрута;
- поменять местами точки начала и конца маршрута;
- выбрать тип маршрутизации;
- удалить маршрут с карты.
Элемент управления «Панель маршрутизации» реализован классом YMapRouteControl.