router.Route

Расширяет IGeoObject, IParentOnMap.

Объект, описывающий проложенный маршрут.

См.: route

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

Конструктор

router.Route(json[, options])

Параметры:

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

Тип: Object

Описание маршрута в формате json.
options —

Тип: Object

Опции маршрута.
options.mapStateAutoApply false

Тип: Boolean

Флаг, позволяющий автоматически установить центр и коэффициент масштабирования карты так, чтобы построенный маршрут был виден целиком.
options.zoomMargin 0

Тип: Number|Number[]

Отступы от границ видимой области карты при изменении коэффициента масштабирования. Если задано одно число - оно применяется ко всем сторонам. Если задано два - то это горизонтальные и вертикальные отступы соответственно. Если задан массив из 4х чисел, то это отступы top, right, bottom, left.
Параметр Значение по умолчанию Описание
json * —

Тип: Object

Описание маршрута в формате json.
options —

Тип: Object

Опции маршрута.
options.mapStateAutoApply false

Тип: Boolean

Флаг, позволяющий автоматически установить центр и коэффициент масштабирования карты так, чтобы построенный маршрут был виден целиком.
options.zoomMargin 0

Тип: Number|Number[]

Отступы от границ видимой области карты при изменении коэффициента масштабирования. Если задано одно число - оно применяется ко всем сторонам. Если задано два - то это горизонтальные и вертикальные отступы соответственно. Если задан массив из 4х чисел, то это отступы top, right, bottom, left.

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

Поля

Имя Тип Описание
editor router.Editor

Редактор маршрутов.
events IEventManager

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

Унаследовано от IDomEventEmitter.
geometry IGeometry

Геометрия геообъекта.

Унаследовано от IGeoObject.
options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.
properties IDataManager

Менеджер данных геообъекта.

Унаследовано от IGeoObject.
state IDataManager
Состояние геообъекта. Определяется следующими полями:
  • active - признак того, что на геообъекте открыт балун.
  • hover - признак того, что в данный момент на геообъект наведен указатель мыши.
  • drag - признак того, что геообъект перетаскивается.

Унаследовано от IGeoObject.
Имя Тип Описание
editor router.Editor

Редактор маршрутов.
events IEventManager

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

Унаследовано от IDomEventEmitter.
geometry IGeometry

Геометрия геообъекта.

Унаследовано от IGeoObject.
options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.
properties IDataManager

Менеджер данных геообъекта.

Унаследовано от IGeoObject.
state IDataManager
Состояние геообъекта. Определяется следующими полями:
  • active - признак того, что на геообъекте открыт балун.
  • hover - признак того, что в данный момент на геообъект наведен указатель мыши.
  • drag - признак того, что геообъект перетаскивается.

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

События

Имя Описание
boundsapply

Событие выставления границ маршрута карте при заданной опции options.mapStateAutoApply.
click

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
contextmenu

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
dblclick

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
geometrychange
Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • originalEvent - оригинальное событие геометрии.

Унаследовано от IGeoObject.
mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IParentOnMap.
mousedown

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
mouseenter

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
mouseleave

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
mousemove

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
mouseup

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
multitouchend

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

Унаследовано от IDomEventEmitter.
multitouchmove

Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

Унаследовано от IDomEventEmitter.
multitouchstart

Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

Унаследовано от IDomEventEmitter.
optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.
overlaychange
Изменение оверлея геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • newOverlay - новый оверлей, либо null, если оверлея нет;
  • oldOverlay - старый оверлей, либо null, если оверлея нет.

Унаследовано от IGeoObject.
parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild.
pixelgeometrychange
Изменение пиксельной геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • newPixelGeometry - новая пиксельная геометрия;
  • oldPixelGeometry - старая пиксельная геометрия.

Унаследовано от IGeoObject.
propertieschange
Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • originalEvent - оригинальное событие менеджера данных.

Унаследовано от IGeoObject.
update

Событие обновления маршрута при включенном редакторе маршрутов.
wheel

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
Имя Описание
boundsapply

Событие выставления границ маршрута карте при заданной опции options.mapStateAutoApply.
click

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
contextmenu

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
dblclick

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
geometrychange
Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • originalEvent - оригинальное событие геометрии.

Унаследовано от IGeoObject.
mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

Унаследовано от IParentOnMap.
mousedown

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
mouseenter

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
mouseleave

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
mousemove

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
mouseup

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

Унаследовано от IDomEventEmitter.
multitouchend

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

Унаследовано от IDomEventEmitter.
multitouchmove

Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

Унаследовано от IDomEventEmitter.
multitouchstart

Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

Унаследовано от IDomEventEmitter.
optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.
overlaychange
Изменение оверлея геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • newOverlay - новый оверлей, либо null, если оверлея нет;
  • oldOverlay - старый оверлей, либо null, если оверлея нет.

Унаследовано от IGeoObject.
parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild.
pixelgeometrychange
Изменение пиксельной геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • newPixelGeometry - новая пиксельная геометрия;
  • oldPixelGeometry - старая пиксельная геометрия.

Унаследовано от IGeoObject.
propertieschange
Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • originalEvent - оригинальное событие менеджера данных.

Унаследовано от IGeoObject.
update

Событие обновления маршрута при включенном редакторе маршрутов.
wheel

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

Методы

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

String

Returns строковое представление времени проезда маршрута с единицами измерения с учетом пробок.
getHumanLength()

String

Returns строковое представление длины маршрута с единицами измерения.
getHumanTime()

String

Returns строковое представление времени проезда маршрута с единицами измерения.
getJamsTime()

Integer

Returns время проезда маршрута в секундах с учетом пробок.
getLength()

Number

Returns длину маршрута в метрах.
getMap()

Map

Returns ссылку на карту.

Унаследован от IParentOnMap.
getOverlay()

IOverlay|null

Returns оверлей геообъекта, либо null.

Унаследован от IGeoObject.
getParent()

IParentOnMap

Returns ссылку на родительский объект.

Унаследован от IChildOnMap.
getPaths()

GeoObjectArray

Returns коллекцию путей, из которых состоит маршрут.
getTime()

Integer

Returns время проезда маршрута в секундах.
getViaPoints()

GeoObjectArray

Returns коллекцию транзитных точек маршрута.
getWayPoints()

GeoObjectArray

Returns коллекцию путевых точек маршрута.
setParent(parent)

IChildOnMap

Устанавливает родительский объект.

Унаследован от IChildOnMap.
Имя Возвращает Описание
getHumanJamsTime()

String

Returns строковое представление времени проезда маршрута с единицами измерения с учетом пробок.
getHumanLength()

String

Returns строковое представление длины маршрута с единицами измерения.
getHumanTime()

String

Returns строковое представление времени проезда маршрута с единицами измерения.
getJamsTime()

Integer

Returns время проезда маршрута в секундах с учетом пробок.
getLength()

Number

Returns длину маршрута в метрах.
getMap()

Map

Returns ссылку на карту.

Унаследован от IParentOnMap.
getOverlay()

IOverlay|null

Returns оверлей геообъекта, либо null.

Унаследован от IGeoObject.
getParent()

IParentOnMap

Returns ссылку на родительский объект.

Унаследован от IChildOnMap.
getPaths()

GeoObjectArray

Returns коллекцию путей, из которых состоит маршрут.
getTime()

Integer

Returns время проезда маршрута в секундах.
getViaPoints()

GeoObjectArray

Returns коллекцию транзитных точек маршрута.
getWayPoints()

GeoObjectArray

Returns коллекцию путевых точек маршрута.
setParent(parent)

IChildOnMap

Устанавливает родительский объект.

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

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

editor

{router.Editor} editor

Редактор маршрутов.

Пример: 

// Начало редактирования маршрута.
ymaps.route(['Москва', 'Питер'], function (route) {
    route.editor.start();
    // ...
    // Завершение редактирования маршрута.
    route.editor.stop();
});

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

boundsapply

Событие выставления границ маршрута карте при заданной опции options.mapStateAutoApply.

update

Событие обновления маршрута при включенном редакторе маршрутов.

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

getHumanJamsTime

{String} getHumanJamsTime()

Returns строковое представление времени проезда маршрута с единицами измерения с учетом пробок.

getHumanLength

{String} getHumanLength()

Returns строковое представление длины маршрута с единицами измерения.

getHumanTime

{String} getHumanTime()

Returns строковое представление времени проезда маршрута с единицами измерения.

getJamsTime

{Integer} getJamsTime()

Returns время проезда маршрута в секундах с учетом пробок.

getLength

{Number} getLength()

Returns длину маршрута в метрах.

getPaths

{GeoObjectArray} getPaths()

Returns коллекцию путей, из которых состоит маршрут.

getTime

{Integer} getTime()

Returns время проезда маршрута в секундах.

getViaPoints

{GeoObjectArray} getViaPoints()

Returns коллекцию транзитных точек маршрута.

getWayPoints

{GeoObjectArray} getWayPoints()

Returns коллекцию путевых точек маршрута.