YMaps.Route
Внимание
Маршрутизация доступна только в актуальных версиях API.
Как перейти на API 2.1
Расширяет YMaps.Polyline.
Класс "Маршрут".
Конструктор
| Имя | Описание |
|---|---|
| YMaps.Route(encodedPoints, levels, boundedBy, routeSegments, distance, duration, viaPoints) | Конструктор маршрута. |
Наследуемые поля
Наследуемые события
- Из YMaps.Polyline:
- AddToMap, BalloonClose, BalloonOpen, Click, DblClick, Drag, DragEnd, DragStart, MouseEnter, MouseLeave, MouseMove, PositionChange, RemoveFromMap, StartDrawing, StartEditing, StopDrawing, StopEditing
Методы
| Имя | Возвращает | Описание |
|---|---|---|
| getDistance() | Number | Возвращает длину маршрута (в метрах). |
| getDuration() | Number | Возвращает расчетное время движения по маршруту (в секундах). |
| getNumRouteSegments() | Integer | Возвращает количество отрезков маршрута. |
| getNumViaPoints() | Integer | Возвращает количество транзитных точек на маршруте. |
| getRouteSegment(index) | YMaps.RouteSegment | Возвращает отрезок маршрута по его индексу. |
| getViaPoint(index) | YMaps.ViaPoint | Возвращает транзитную точку на маршруте по ее индексу. |
Наследуемые методы
- Из YMaps.Polyline:
- addPoint, getClosestPoint, getCoordPath, getEditingOptions, getMap, getNumPoints, getOptions, getPixelPoints, getPoint, getPoints, isDrawing, isEditing, removePoint, setEditingOptions, setOptions, setPoints, splicePoints, startEditing, stopEditing
- Из YMaps.IOverlay:
- onAddToMap, onMapUpdate, onRemoveFromMap
- Из YMaps.IInteractiveGeoObject:
- closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions, openBalloon, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions, update
- Из YMaps.IGeoObject:
- getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup, setBounds, setStyle
Подробное описание конструктора
YMaps.Route(encodedPoints, levels, boundedBy, routeSegments, distance, duration, viaPoints)
Конструктор маршрута.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
encodedPoints |
String | Закодированные в Base64 точки. |
levels |
String[] | Уровни точек. |
boundedBy |
YMaps.GeoBounds | Прямоугольная область на карте, полностью охватывающая маршрут. |
routeSegments |
YMaps.RouteSegment[] | Массив отрезков маршрута. |
distance |
Number | Длина маршрута (в метрах). |
duration |
Number | Расчетное время проезда маршрута (в секундах). |
viaPoints |
YMaps.ViaPoint[] | Массив транзитных точек на маршруте. |
Подробное описание методов
getDistance
{Number} getDistance()
Возвращает длину маршрута (в метрах).
Возвращает:
| Тип | Описание |
|---|---|
| Number | Длина маршрута. |
getDuration
{Number} getDuration()
Возвращает расчетное время движения по маршруту (в секундах).
Возвращает:
| Тип | Описание |
|---|---|
| Number | Расчетное время движения по маршруту (в секундах). |
getNumRouteSegments
{Integer} getNumRouteSegments()
Возвращает количество отрезков маршрута.
Возвращает:
| Тип | Описание |
|---|---|
| Integer | Количество отрезков. |
getNumViaPoints
{Integer} getNumViaPoints()
Возвращает количество транзитных точек на маршруте.
Возвращает:
| Тип | Описание |
|---|---|
| Integer | Количество транзитных точек на маршруте. |
getRouteSegment
{YMaps.RouteSegment} getRouteSegment(index)
Возвращает отрезок маршрута по его индексу.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
index |
Integer | Индекс отрезка в маршруте. |
Возвращает:
| Тип | Описание |
|---|---|
| YMaps.RouteSegment | Отрезок маршрута. |
getViaPoint
{YMaps.ViaPoint} getViaPoint(index)
Возвращает транзитную точку на маршруте по ее индексу.
Параметры:
| Имя | Тип | Описание |
|---|---|---|
index |
Integer | Индекс точки. |
Возвращает:
| Тип | Описание |
|---|---|
| YMaps.ViaPoint | Транзитную точку. |