Документация
Справочник JavaScript API
2.1.55 (текущая версия)
collection
interactivityModel
Интерфейсы

router.Route

Примечание. Конструктор класса router.Route скрыт, так как данный класс не предназначен для самостоятельной инициализации.

Расширяет IGeoObject.

Объект, описывающий проложенный маршрут. Конструктор недоступен в package.full (стандартный набор модулей). Данный модуль загружается по требованию.

См.: route

Поля | События | Методы

Поля

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

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

eventsIEventManager

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

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

geometryIGeometry|null

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

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

optionsIOptionManager

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

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

propertiesIDataManager

Данные геообъекта.

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

stateIDataManager

Состояние геообъекта.

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

События

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

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

click

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

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

contextmenu

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

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

dblclick

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

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

geometrychange

Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • originalEvent: IEvent - оригинальное событие геометрии.

Унаследовано от 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.

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

multitouchmove

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

  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

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

multitouchstart

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

  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

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

optionschange

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

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

overlaychange

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

  • overlay: IOverlay|null - ссылка на оверлей;
  • oldOverlay: IOverlay|null - предыдущий оверлей геообъекта.

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

parentchange

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

Поля данных:

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

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

propertieschange

Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • originalEvent: IEvent - оригинальное событие менеджера данных.

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

update

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

wheel

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

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

Методы

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

String

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

getHumanLength()

String

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

getHumanTime()

String

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

getJamsTime()

Integer

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

getLength()

Number

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

getMap()

Map

Возвращает ссылку на карту.

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

getOverlay()

vow.Promise

Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки.

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

getOverlaySync()

IOverlay|null

Метод предоставляет синхронный доступ к оверлею.

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

getParent()

IControlParent|null

Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

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

getPaths()

GeoObjectCollection

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

getTime()

Integer

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

getViaPoints()

GeoObjectCollection

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

getWayPoints()

GeoObjectCollection

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

setParent(parent)

IChildOnMap

Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

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

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

editor

{router.Editor} editor

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

Пример:

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

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

boundsapply

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

update

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

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

getHumanJamsTime

{String} getHumanJamsTime()

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

getHumanLength

{String} getHumanLength()

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

getHumanTime

{String} getHumanTime()

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

getJamsTime

{Integer} getJamsTime()

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

getLength

{Number} getLength()

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

getPaths

{GeoObjectCollection} getPaths()

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

getTime

{Integer} getTime()

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

getViaPoints

{GeoObjectCollection} getViaPoints()

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

getWayPoints

{GeoObjectCollection} getWayPoints()

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