multiRouter.driving.Route

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

Расширяет IGeoObject.

Отображение единичного автомобильного маршрута. Мультимаршрут может состоять из нескольких единичных маршрутов.

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

Создает отображение единичного автомобильного маршрута.

Поля

ИмяТипОписание
balloonIMultiRouterRouteBalloon

Балун маршрута.

eventsIEventManager

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

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

geometryIGeometry|null

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

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

modelmultiRouter.driving.RouteModel

Модель данных единичного маршрута.

optionsIOptionManager

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

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

propertiesdata.Manager
Данные маршрута. Доступны следующие поля:
  • index: Integer - порядковый номер маршрута в мультимаршруте;
  • type: String - идентификатор типа маршрута, принимающий значение "driving" для автомобильных маршрутов;
  • blocked: Boolean - признак того, что маршрут содержит перекрытые участки;
  • distance: Object - объект с полями text и value, описывающий протяженность маршрута в метрах;
  • duration: Object - объект с полями text и value, описывающий время проезда маршрута в секундах;
  • durationInTraffic: Object - объект с полями text и value, описывающий время проезда пути в секундах с учетом пробок;
  • boundedBy: Number[][] - координаты нижнего и верхнего углов прямоугольника, ограничивающего маршрут.
stateIDataManager

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

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

События

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

Закрытие балуна.

balloonopen

Открытие балуна.

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

Обновление отображения маршрута. Экземпляр класса Event.

wheel

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

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

Методы

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

Map

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

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

getOverlay()

vow.Promise

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

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

getOverlaySync()

IOverlay|null

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

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

getParent()

IParentOnMap|null

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

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

getPaths()

GeoObjectCollection

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

setParent(parent)

IChildOnMap

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

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

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

balloon

Балун маршрута.

model

Модель данных единичного маршрута.

properties

{data.Manager} properties
Данные маршрута. Доступны следующие поля:
  • index: Integer - порядковый номер маршрута в мультимаршруте;
  • type: String - идентификатор типа маршрута, принимающий значение "driving" для автомобильных маршрутов;
  • blocked: Boolean - признак того, что маршрут содержит перекрытые участки;
  • distance: Object - объект с полями text и value, описывающий протяженность маршрута в метрах;
  • duration: Object - объект с полями text и value, описывающий время проезда маршрута в секундах;
  • durationInTraffic: Object - объект с полями text и value, описывающий время проезда пути в секундах с учетом пробок;
  • boundedBy: Number[][] - координаты нижнего и верхнего углов прямоугольника, ограничивающего маршрут.

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

balloonclose

Закрытие балуна.

balloonopen

Открытие балуна.

update

Обновление отображения маршрута. Экземпляр класса Event.

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

getPaths

{GeoObjectCollection} getPaths()

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