--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.ru/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/multiRouter.masstransit.Path.md - https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.masstransit.Path.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt # multiRouter.masstransit.Path {% note info %} Конструктор класса multiRouter.masstransit.Path скрыт, так как данный класс не предназначен для самостоятельной инициализации. {% endnote %} Расширяет [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md). Отображение пути маршрута общественного транспорта. Единичный маршрут может содержать несколько путей, каждый путь соединяет две путевые точки. [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary) Создает отображение пути маршрута общественного транспорта. ## Поля {#properties-summary} #| || **Имя** | **Тип** | **Описание** || || [events](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#events). || || [geometry](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#geometry) | [IGeometry](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeometry.md)\|null | Геометрия геообъекта. Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#geometry). || || [model](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.masstransit.Path.md#model) | [multiRouter.masstransit.PathModel](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.masstransit.PathModel.md) | Модель данных пути мультимаршрута. || || [options](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций. Унаследовано от [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options). || || [properties](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.masstransit.Path.md#properties) | [data.Manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Модель данных пути мультимаршрута. Доступны следующие поля: - index: Integer - порядковый номер пути в соответствующем маршруте мультимаршрута; - type: String – идентификатор типа маршрута. Принимает значение "masstransit" для маршрутов общественного транспорта; - distance: Object - объект с полями text и value, описывающий протяженность пути в метрах; - duration: Object - объект с полями text и value, описывающий время движения по пути в секундах; - coordinates: Number[][] - координаты всех точек пути; - encodedCoordinates: String - строка закодированных в base64 координат всех точек пути. || || [state](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#state) | [IDataManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager.md) | Состояние геообъекта. Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#state). || |# ## События {#events-summary} #| || **Имя** | **Описание** || || [click](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click). || || [contextmenu](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu). || || [dblclick](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick). || || [geometrychange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-geometrychange) | Изменение геометрии геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - originalEvent: [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md) - оригинальное событие геометрии. Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-geometrychange). || || [mapchange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange) | Сменилась карта. Поля данных: - oldMap - старая карта; - newMap - новая карта. Унаследовано от [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange). || || [mousedown](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown). || || [mouseenter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter). || || [mouseleave](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave). || || [mousemove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove). || || [mouseup](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup). || || [multitouchend](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend). || || [multitouchmove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля: - clientX - координата касания X относительно видимой области браузера; - clientY - координата касания Y относительно видимой области браузера; - pageX - координата касания X касания относительно начала документа; - pageY - координата касания Y касания относительно начала документа. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove). || || [multitouchstart](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля: - clientX - координата касания X относительно видимой области браузера; - clientY - координата касания Y относительно видимой области браузера; - pageX - координата касания X касания относительно начала документа; - pageY - координата касания Y касания относительно начала документа. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart). || || [optionschange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта. Унаследовано от [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange). || || [overlaychange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-overlaychange) | Изменение оверлея геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - overlay: [IOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null - ссылка на оверлей; - oldOverlay: [IOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null - предыдущий оверлей геообъекта. Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-overlaychange). || || [parentchange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект. Поля данных: - oldParent - старый родитель; - newParent - новый родитель. Унаследовано от [IChild](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange). || || [propertieschange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-propertieschange) | Изменение данных геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get): - originalEvent: [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md) - оригинальное событие менеджера данных. Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-propertieschange). || || [update](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.masstransit.Path.md#event-update) | Обновление отображения пути. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). || || [wheel](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel). || |# ## Методы {#methods-summary} #| || **Имя** | **Возвращает** | **Описание** || || [getMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#getMap)() | [Map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает ссылку на карту. Унаследован от [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#getMap). || || [getOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlay)() | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки. Унаследован от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlay). || || [getOverlaySync](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlaySync)() | [IOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null | Метод предоставляет синхронный доступ к оверлею. Унаследован от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlaySync). || || [getParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md)\|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent). || || [getSegmentMarkers](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.masstransit.Path.md#getSegmentMarkers)() | [GeoObjectCollection](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObjectCollection.md) | Возвращает дочернюю коллекцию маркеров сегментов. || || [getSegments](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.masstransit.Path.md#getSegments)() | [GeoObjectCollection](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObjectCollection.md) | Возвращает дочернюю коллекцию сегментов, из которых состоит путь. || || [setParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent). || |# ## Описание полей {#field_detail} ### model {#model} ```javascript {multiRouter.masstransit.PathModel} model ``` Модель данных пути мультимаршрута. ### properties {#properties} ```javascript {data.Manager} properties ``` Модель данных пути мультимаршрута. Доступны следующие поля: - index: Integer - порядковый номер пути в соответствующем маршруте мультимаршрута; - type: String – идентификатор типа маршрута. Принимает значение "masstransit" для маршрутов общественного транспорта; - distance: Object - объект с полями text и value, описывающий протяженность пути в метрах; - duration: Object - объект с полями text и value, описывающий время движения по пути в секундах; - coordinates: Number[][] - координаты всех точек пути; - encodedCoordinates: String - строка закодированных в base64 координат всех точек пути. ## Описание событий {#event_detail} ### update {#update} Обновление отображения пути. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ## Описание методов {#method_detail} ### getSegmentMarkers {#getSegmentMarkers} ```javascript {GeoObjectCollection} getSegmentMarkers() ``` **Возвращает** дочернюю коллекцию маркеров сегментов. ### getSegments {#getSegments} ```javascript {GeoObjectCollection} getSegments() ``` **Возвращает** дочернюю коллекцию сегментов, из которых состоит путь.