Path
Расширяет GeoObject.
Объект, описывающий часть (путь) маршрута. Маршрут может содержать несколько путей, каждый путь соединяет две путевые точки. Для путей доступны следующие пресеты:
• 'router#interactivePath' - обеспечивает вывод информации о сегменте пути при клике по полилинии пути. При использовании этого пресета в макете балуна становятся доступными, как свойства геообъекта, следующие данные сегмента router.Segment: action, humanAction, angle, lenght, humanLength, time, humanTime, jamsTime, humanJamsTime, street. Используется по умолчанию.
• 'router#plainPath' - путь ведет себя как обычный геообъект.
См.: route
Конструктор
router.Path(feature[, options])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Object Геометрия и свойства пути. |
|
— |
Тип: Object Опции пути. |
* Обязательный параметр/опция.
Поля
Имя |
Тип |
Описание |
Балун геообъекта. Унаследовано от GeoObject. |
||
Редактор геометрии геообъекта. Унаследовано от GeoObject. |
||
Менеджер событий. Унаследовано от GeoObject. |
||
Геометрия геообъекта. Унаследовано от IGeoObject. |
||
Хинт геообъекта. Унаследовано от GeoObject. |
||
Менеджер опций геообъекта. Унаследовано от GeoObject. |
||
Менеджер данных геообъекта. Унаследовано от GeoObject. |
||
Состояние геообъекта. Определяется следующими полями: • hover - признак того, что в данный момент на геообъект наведен указатель мыши. • drag - признак того, что геообъект перетаскивается. Унаследовано от GeoObject. |
События
Имя |
Описание |
Закрытие балуна. Экземпляр класса Event. Унаследовано от GeoObject. |
|
Открытие балуна на геообъекте. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • balloon - экземпляр класса Balloon. Унаследовано от GeoObject. |
|
Текст |
Текст |
Событие, предшествующее событию drag. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге. Имена методов, доступных через метод Event.callMethod: • setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел. Если у данного события вызвать метод Event.preventDefault, то последующее событие drag будет отменено. Унаследовано от GeoObject. |
|
Событие, предшествующее событию dragstart. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется. Если у данного события вызвать метод Event.preventDefault, то последующее перетаскивание, как и событие dragstart, будет отменено. Унаследовано от GeoObject. |
|
Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Перетаскивание геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге. Унаследовано от GeoObject. |
|
Завершение перетаскивания геообъекта. Экземпляр класса Event. Унаследовано от GeoObject. |
|
Начало перетаскивания геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется. Унаследовано от GeoObject. |
|
Изменение состояния редактора геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • originalEvent - оригинальное событие редактора геометрии. Унаследовано от GeoObject. |
|
Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • originalEvent - оригинальное событие геометрии. Унаследовано от IGeoObject. |
|
Сменилась карта. Поля данных: • oldMap - старая карта; • newMap - новая карта. Унаследовано от IParentOnMap. |
|
Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
|
Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
|
Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от IDomEventEmitter. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Изменение оверлея геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • newOverlay - новый оверлей, либо null, если оверлея нет; • oldOverlay - старый оверлей, либо null, если оверлея нет. Унаследовано от IGeoObject. |
|
Сменился родительский объект. Поля данных: • oldParent - старый родитель; • newParent - новый родитель. Унаследовано от IChild. |
|
Изменение пиксельной геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • newPixelGeometry - новая пиксельная геометрия; • oldPixelGeometry - старая пиксельная геометрия. Унаследовано от IGeoObject. |
|
Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • originalEvent - оригинальное событие менеджера данных. Унаследовано от IGeoObject. |
|
Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Унаследовано от IDomEventEmitter. |
Методы
Имя |
Возвращает |
Описание |
String |
Returns строковое представление времени проезда пути с единицами измерения с учетом пробок. |
|
String |
Returns строковое представление длины пути с единицами измерения. |
|
String |
Returns строковое представление времени проезда пути с единицами измерения. |
|
Integer |
Returns время проезда пути в секундах с учетом пробок. |
|
Number |
Returns длину пути в метрах. |
|
getMap() |
Returns ссылку на карту. Унаследован от IParentOnMap. |
|
IOverlay|null |
Returns оверлей геообъекта, либо null. Унаследован от IGeoObject. |
|
Returns ссылку на родительский объект. Унаследован от IChildOnMap. |
||
Returns сегменты пути. |
||
getTime() |
Integer |
Returns время проезда пути в секундах. |
Устанавливает родительский объект. Унаследован от 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 время проезда пути в секундах.
Обязательный параметр/опция.