router.Path

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

Расширяет GeoObject .

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

См.: route

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

Поля

Имя Тип Описание
balloon geoObject.Balloon

Балун геообъекта.

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

editor IGeometryEditor

Редактор геометрии геообъекта.

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

events event.Manager

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

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

geometry IGeometry |null

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

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

hint geoObject.Hint

Хинт геообъекта.

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

options option.Manager

Менеджер опций геообъекта.

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

properties data.Manager

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

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

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

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

События

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

Закрытие балуна. Экземпляр класса Event .

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

balloonopen

Открытие балуна на геообъекте. Экземпляр класса Event .

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

beforedrag
Событие, предшествующее событию drag. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent ), если оно имеется.
Имена методов, доступных через метод Event.callMethod :
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault , то последующее событие drag будет отменено.

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

beforedragstart
Событие, предшествующее событию dragstart. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • domEvent - исходное DOM-событие (в виде объекта DomEvent ), если оно имеется.
Если у данного события вызвать метод Event.preventDefault , то последующее перетаскивание, как и событие dragstart, будет отменено.

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

click

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

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

contextmenu

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

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

dblclick

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

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

drag
Перетаскивание геообъекта. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent ), если оно имеется.

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

dragend
Завершение перетаскивания геообъекта. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • domEvent - исходное DOM-событие (в виде объекта DomEvent ), если оно имеется.

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

dragstart
Начало перетаскивания геообъекта. Экземпляр класса Event . Имена полей, доступных через метод Event.get :
  • position - координаты относительно документа. Массива вида [pageX, pageY];
  • domEvent - исходное DOM-событие (в виде объекта DomEvent ), если оно имеется.

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

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

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

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

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

hintclose

Закрытие хинта. Экземпляр класса Event .

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

hintopen

Открытие хинта на геообъекте. Экземпляр класса Event .

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

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 .

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 ()

IParentOnMap |null

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

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

getSegments ()

router.Segment []

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

getTime ()

Integer

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

setParent (parent)

IChildOnMap

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

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

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

getHumanJamsTime

{String} getHumanJamsTime()

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

getHumanLength

{String} getHumanLength()

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

getHumanTime

{String} getHumanTime()

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

getJamsTime

{Integer} getJamsTime()

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

getLength

{Number} getLength()

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

getSegments

{router.Segment[]} getSegments()

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

getTime

{Integer} getTime()

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