router.Path

Расширяет GeoObject.

Объект, описывающий часть (путь) маршрута. Маршрут может содержать несколько путей, каждый путь соединяет две путевые точки. Для путей доступны следующие пресеты:
  • 'router#interactivePath' - обеспечивает вывод информации о сегменте пути при клике по полилинии пути. При использовании этого пресета в макете балуна становятся доступными, как свойства геообъекта, следующие данные сегмента router.Segment: action, humanAction, angle, lenght, humanLength, time, humanTime, jamsTime, humanJamsTime, street. Используется по умолчанию.
  • 'router#plainPath' - путь ведет себя как обычный геообъект.

См.: route

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

Конструктор

router.Path(feature[, options])

Параметры:

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

Тип: Object

Геометрия и свойства пути.
options —

Тип: Object

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

Тип: Object

Геометрия и свойства пути.
options —

Тип: Object

Опции пути.

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

Поля

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Унаследовано от GeoObject.
Имя Тип Описание
balloon geoObject.Balloon

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

События

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

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

Унаследовано от GeoObject.
balloonopen
Открытие балуна на геообъекте. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • balloon - экземпляр класса Balloon.

Унаследовано от GeoObject.
beforedrag
Событие, предшествующее событию drag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге.
Имена методов, доступных через метод Event.callMethod:
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то последующее событие drag будет отменено.

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

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

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

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

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

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

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

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

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

Завершение перетаскивания геообъекта. Экземпляр класса Event.

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

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

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

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

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

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

Унаследовано от GeoObject.
balloonopen
Открытие балуна на геообъекте. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • balloon - экземпляр класса Balloon.

Унаследовано от GeoObject.
beforedrag
Событие, предшествующее событию drag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
  • pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге.
Имена методов, доступных через метод Event.callMethod:
  • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод Event.preventDefault, то последующее событие drag будет отменено.

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

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

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

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

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

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

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

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

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

Завершение перетаскивания геообъекта. Экземпляр класса Event.

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

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

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

router.Segment[]

Returns сегменты пути.
getTime()

Integer

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

router.Segment[]

Returns сегменты пути.
getTime()

Integer

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

IChildOnMap

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

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

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

getHumanJamsTime

{String} getHumanJamsTime()

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

getHumanLength

{String} getHumanLength()

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

getHumanTime

{String} getHumanTime()

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

getJamsTime

{Integer} getJamsTime()

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

getLength

{Number} getLength()

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

getSegments

{router.Segment[]} getSegments()

Returns сегменты пути.

getTime

{Integer} getTime()

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