router.Route
Расширяет IGeoObject, IParentOnMap.
Объект, описывающий проложенный маршрут.
См.: route
Конструктор
router.Route(json[, options])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Object Описание маршрута в формате json. |
|
— |
Тип: Object Опции маршрута. |
|
false |
Тип: Boolean Флаг, позволяющий автоматически установить центр и коэффициент масштабирования карты так, чтобы построенный маршрут был виден целиком. |
|
0 |
Тип: Number|Number[] Отступы от границ видимой области карты при изменении коэффициента масштабирования. Если задано одно число - оно применяется ко всем сторонам. Если задано два - то это горизонтальные и вертикальные отступы соответственно. Если задан массив из 4х чисел, то это отступы top, right, bottom, left. |
* Обязательный параметр/опция.
Поля
Имя |
Тип |
Описание |
Редактор маршрутов. |
||
Менеджер событий. Унаследовано от IDomEventEmitter. |
||
Геометрия геообъекта. Унаследовано от IGeoObject. |
||
Менеджер опций. Унаследовано от ICustomizable. |
||
Менеджер данных геообъекта. Унаследовано от IGeoObject. |
||
Состояние геообъекта. Определяется следующими полями: • hover - признак того, что в данный момент на геообъект наведен указатель мыши. • drag - признак того, что геообъект перетаскивается. Унаследовано от IGeoObject. |
События
Имя |
Описание |
Событие выставления границ маршрута карте при заданной опции options.mapStateAutoApply. |
|
Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • originalEvent - оригинальное событие геометрии. Унаследовано от IGeoObject. |
|
Сменилась карта. Поля данных: • oldMap - старая карта; • newMap - новая карта. Унаследовано от IParentOnMap. |
|
Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
|
Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
|
Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Изменение оверлея геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • newOverlay - новый оверлей, либо null, если оверлея нет; • oldOverlay - старый оверлей, либо null, если оверлея нет. Унаследовано от IGeoObject. |
|
Сменился родительский объект. Поля данных: • oldParent - старый родитель; • newParent - новый родитель. Унаследовано от IChild. |
|
Изменение пиксельной геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • newPixelGeometry - новая пиксельная геометрия; • oldPixelGeometry - старая пиксельная геометрия. Унаследовано от IGeoObject. |
|
Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • originalEvent - оригинальное событие менеджера данных. Унаследовано от IGeoObject. |
|
Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
Методы
Имя |
Возвращает |
Описание |
String |
Returns строковое представление времени проезда пути с единицами измерения с учетом пробок. |
|
String |
Returns строковое представление длины пути с единицами измерения. |
|
String |
Returns строковое представление времени проезда маршрута с единицами измерения. |
|
Integer |
Returns время проезда маршрута в секундах с учетом пробок. |
|
Number |
Returns длину пути в метрах. |
|
getMap() |
Returns ссылку на карту. Унаследован от IParentOnMap. |
|
IOverlay|null |
Returns оверлей геообъекта, либо null. Унаследован от IGeoObject. |
|
Returns ссылку на родительский объект. Унаследован от IChildOnMap. |
||
getPaths() |
Returns коллекцию путей, из которых состоит маршрут. |
|
getTime() |
Integer |
Returns время проезда маршрута в секундах. |
Returns коллекцию транзитных точек маршрута. |
||
Returns коллекцию путевых точек маршрута. |
||
Устанавливает родительский объект. Унаследован от 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 коллекцию путевых точек маршрута.
Обязательный параметр/опция.