---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/route.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.Route


{% note alert %}

Маршрутизация доступна только в актуальных версиях API. 
[Как перейти на API 2.1](https://yandex.ru/dev/maps/jsapi/doc/2.1/upgrade/index.html)

{% endnote %}


Расширяет [YMaps.Polyline](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md).

Класс "Маршрут".

## Конструктор

Имя | Описание
----- | -----
[YMaps.Route](route.md#constructor)(encodedPoints, levels, boundedBy, routeSegments, distance, duration, viaPoints) | Конструктор маршрута.

## Наследуемые поля


Из [YMaps.Polyline](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md): 
: [Events](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#Events)

Из [YMaps.IGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md): 
: [description](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#description), [id](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#id), [metaDataProperty](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#metaDataProperty), [name](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#name)

## Наследуемые события


Из [YMaps.Polyline](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md): 
: [AddToMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-AddToMap), [BalloonClose](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-BalloonClose), [BalloonOpen](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-BalloonOpen), [Click](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-Click), [DblClick](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-DblClick), [Drag](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-Drag), [DragEnd](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-DragEnd), [DragStart](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-DragStart), [MouseEnter](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-MouseEnter), [MouseLeave](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-MouseLeave), [MouseMove](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-MouseMove), [PositionChange](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-PositionChange), [RemoveFromMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-RemoveFromMap), [StartDrawing](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-StartDrawing), [StartEditing](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-StartEditing), [StopDrawing](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-StopDrawing), [StopEditing](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#event-StopEditing)

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getDistance](route.md#getDistance)() | Number | Возвращает длину маршрута (в метрах).
[getDuration](route.md#getDuration)() | Number | Возвращает расчетное время движения по маршруту (в секундах).
[getNumRouteSegments](route.md#getNumRouteSegments)() | Integer | Возвращает количество отрезков маршрута.
[getNumViaPoints](route.md#getNumViaPoints)() | Integer | Возвращает количество транзитных точек на маршруте.
[getRouteSegment](route.md#getRouteSegment)(index) | [YMaps.RouteSegment](routesegment.md) | Возвращает отрезок маршрута по его индексу.
[getViaPoint](route.md#getViaPoint)(index) | [YMaps.ViaPoint](viapoint.md) | Возвращает транзитную точку на маршруте по ее индексу.

## Наследуемые методы


Из [YMaps.Polyline](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md): 
: [addPoint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#addPoint), [getClosestPoint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#getClosestPoint), [getCoordPath](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#getCoordPath), [getEditingOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#getEditingOptions), [getMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#getMap), [getNumPoints](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#getNumPoints), [getOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#getOptions), [getPixelPoints](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#getPixelPoints), [getPoint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#getPoint), [getPoints](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#getPoints), [isDrawing](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#isDrawing), [isEditing](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#isEditing), [removePoint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#removePoint), [setEditingOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#setEditingOptions), [setOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#setOptions), [setPoints](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#setPoints), [splicePoints](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#splicePoints), [startEditing](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#startEditing), [stopEditing](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polyline.md#stopEditing)

Из [YMaps.IOverlay](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md): 
: [onAddToMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onAddToMap), [onMapUpdate](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onMapUpdate), [onRemoveFromMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onRemoveFromMap)

Из [YMaps.IInteractiveGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md): 
: [closeBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#closeBalloon), [getBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getBalloon), [getBalloonContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getBalloonContent), [getBalloonOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getBalloonOptions), [getHintContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getHintContent), [getHintOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getHintOptions), [openBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#openBalloon), [setBalloonContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setBalloonContent), [setBalloonOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setBalloonOptions), [setHintContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setHintContent), [setHintOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setHintOptions), [update](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#update)

Из [YMaps.IGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md): 
: [getBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getBounds), [getComputedStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getComputedStyle), [getParentGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getParentGroup), [getStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getStyle), [onAddToGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#onAddToGroup), [onRemoveFromGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#onRemoveFromGroup), [setBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#setBounds), [setStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#setStyle)

## Подробное описание конструктора {#constructor}

```javascript
YMaps.Route(encodedPoints, levels, boundedBy, routeSegments, distance, duration, viaPoints)
```

Конструктор маршрута.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`encodedPoints` | String | Закодированные в Base64 точки.
`levels` | String[] | Уровни точек.
`boundedBy` | [YMaps.GeoBounds](geobounds.md) | Прямоугольная область на карте, полностью охватывающая маршрут.
`routeSegments` | [YMaps.RouteSegment](routesegment.md)[] | Массив отрезков маршрута.
`distance` | Number | Длина маршрута (в метрах).
`duration` | Number | Расчетное время проезда маршрута (в секундах).
`viaPoints` | [YMaps.ViaPoint](viapoint.md)[] | Массив транзитных точек на маршруте.

## Подробное описание методов {#method_detail}

### getDistance {#getDistance}

```javascript
{Number} getDistance()
```

Возвращает длину маршрута (в метрах).

**Возвращает:**

Тип | Описание
----- | -----
Number | Длина маршрута.

### getDuration {#getDuration}

```javascript
{Number} getDuration()
```

Возвращает расчетное время движения по маршруту (в секундах).

**Возвращает:**

Тип | Описание
----- | -----
Number | Расчетное время движения по маршруту (в секундах).

### getNumRouteSegments {#getNumRouteSegments}

```javascript
{Integer} getNumRouteSegments()
```

Возвращает количество отрезков маршрута.

**Возвращает:**

Тип | Описание
----- | -----
Integer | Количество отрезков.

### getNumViaPoints {#getNumViaPoints}

```javascript
{Integer} getNumViaPoints()
```

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

**Возвращает:**

Тип | Описание
----- | -----
Integer | Количество транзитных точек на маршруте.

### getRouteSegment {#getRouteSegment}

```javascript
{YMaps.RouteSegment} getRouteSegment(index)
```

Возвращает отрезок маршрута по его индексу.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`index` | Integer | Индекс отрезка в маршруте.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.RouteSegment](routesegment.md) | Отрезок маршрута.

### getViaPoint {#getViaPoint}

```javascript
{YMaps.ViaPoint} getViaPoint(index)
```

Возвращает транзитную точку на маршруте по ее индексу.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`index` | Integer | Индекс точки.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ViaPoint](viapoint.md) | Транзитную точку.