multiRouter.driving.Path
Расширяет IGeoObject.
Отображение пути автомобильного мультимаршрута. Единичный маршрут может содержать несколько путей, каждый путь соединяет две путевые точки.
Создает отображение пути автомобильного мультимаршрута.
Поля
Имя | Тип | Описание |
---|---|---|
events | IEventManager | Менеджер событий. Унаследовано от IDomEventEmitter. |
geometry | IGeometry|null | Геометрия геообъекта. Унаследовано от IGeoObject. |
model | multiRouter.driving.PathModel | Модель данных пути мультимаршрута. |
options | IOptionManager | Менеджер опций. Унаследовано от ICustomizable. |
properties | data.Manager | Модель данных пути мультимаршрута. Доступны следующие поля:
|
state | IDataManager | Состояние геообъекта. Унаследовано от IGeoObject. |
Имя | Тип | Описание |
---|---|---|
events | IEventManager | Менеджер событий. Унаследовано от IDomEventEmitter. |
geometry | IGeometry|null | Геометрия геообъекта. Унаследовано от IGeoObject. |
model | multiRouter.driving.PathModel | Модель данных пути мультимаршрута. |
options | IOptionManager | Менеджер опций. Унаследовано от ICustomizable. |
properties | data.Manager | Модель данных пути мультимаршрута. Доступны следующие поля:
|
state | IDataManager | Состояние геообъекта. Унаследовано от IGeoObject. |
События
Имя | Описание |
---|---|
click | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
contextmenu | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
dblclick | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
geometrychange | Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
mapchange | Сменилась карта. Поля данных:
Унаследовано от 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, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
Унаследовано от IDomEventEmitter. |
multitouchstart | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
Унаследовано от IDomEventEmitter. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
overlaychange | Унаследовано от IGeoObject. |
parentchange | Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
propertieschange | Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
update | Обновление отображения пути. Экземпляр класса Event. |
wheel | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
Имя | Описание |
---|---|
click | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
contextmenu | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
dblclick | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
geometrychange | Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
mapchange | Сменилась карта. Поля данных:
Унаследовано от 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, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
Унаследовано от IDomEventEmitter. |
multitouchstart | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
Унаследовано от IDomEventEmitter. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
overlaychange | Унаследовано от IGeoObject. |
parentchange | Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
propertieschange | Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
update | Обновление отображения пути. Экземпляр класса Event. |
wheel | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
Методы
Имя | Возвращает | Описание |
---|---|---|
getMap() | Возвращает ссылку на карту. Унаследован от IParentOnMap. | |
getOverlay() | Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки. Унаследован от IGeoObject. | |
getOverlaySync() | IOverlay|null | Метод предоставляет синхронный доступ к оверлею. Унаследован от IGeoObject. |
getParent() | IParentOnMap|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IChildOnMap. |
getSegments() | Возвращает дочернюю коллекцию сегментов, из которых состоит путь. | |
setParent(parent) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IChildOnMap. |
Имя | Возвращает | Описание |
---|---|---|
getMap() | Возвращает ссылку на карту. Унаследован от IParentOnMap. | |
getOverlay() | Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки. Унаследован от IGeoObject. | |
getOverlaySync() | IOverlay|null | Метод предоставляет синхронный доступ к оверлею. Унаследован от IGeoObject. |
getParent() | IParentOnMap|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IChildOnMap. |
getSegments() | Возвращает дочернюю коллекцию сегментов, из которых состоит путь. | |
setParent(parent) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IChildOnMap. |
Описание полей
model
{multiRouter.driving.PathModel} model
Модель данных пути мультимаршрута.
properties
{data.Manager} properties
- index: Integer - порядковый номер пути в соответствующем маршруте мультимаршрута;
- type: String - идентификатор типа маршрута, принимающий значение "driving" для автомобильных маршрутов;
- distance: Object - объект с полями text и value, описывающий протяженность пути в метрах;
- duration: Object - объект с полями text и value, описывающий время движения по пути в секундах;
- durationInTraffic: Object - объект с полями text и value, описывающий время проезда пути в секундах с учетом пробок;
- coordinates: Number[][] - координаты всех точек пути;
- encodedCoordinates: String - строка закодированных в base64 координат всех точек пути.
Описание событий
update
Обновление отображения пути. Экземпляр класса Event.
Описание методов
getSegments
{GeoObjectCollection} getSegments()
Возвращает дочернюю коллекцию сегментов, из которых состоит путь.