Polyline

Расширяет GeoObject.

Ломаная линия. Представляет собой геообъект с геометрией geometry.LineString.

Конструктор

Polyline(geometry[, properties[, options]])

Создает экземпляр ломаной.

Параметры:

Параметр	Значение по умолчанию	Описание
`geometry`[](parametr)	—	Тип: Number[][]\|Object\|ILineStringGeometry Координаты вершин, хэш-объект с параметрами геометрии или ссылка на объект геометрии ломаной линии.
`properties`	—	Тип: Object\|IDataManager Данные метки. Соответствуют данным класса GeoObject.
`options`	—	Тип: Object Опции метки. Соответствуют опциям класса GeoObject.

Пример:

// Создаем ломаную линию.
var polyline = new ymaps.Polyline([
    [-80, 60], [-90, 50], [-60, 40], [-80, 60]
], {
    hintContent: "Ломаная линия"
}, {
    draggable: true,
    strokeColor: '#000000',
    strokeWidth: 4,
    // Первой цифрой задаем длину штриха. Второй цифрой задаем длину разрыва.
    strokeStyle: '1 5'
});
// Добавляем линию на карту.
myMap.geoObjects.add(polyline);
// Устанавливаем карте границы линии.
myMap.setBounds(polyline.geometry.getBounds());

Поля

Имя	Тип	Описание
balloon	geoObject.Balloon	Балун геообъекта. Унаследовано от GeoObject.
editor	geometryEditor.LineString	Редактор геометрии "Ломаная линия".
events	event.Manager	Менеджер событий. Унаследовано от GeoObject.
geometry	geometry.LineString	Геометрия типа "Ломаная линия".
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.

Методы

Имя	Возвращает	Описание
getMap()	Map	Returns ссылку на карту. Унаследован от IParentOnMap.
getOverlay()	IOverlay\|null	Returns оверлей геообъекта, либо null. Унаследован от IGeoObject.
getParent()	IParentOnMap	Returns ссылку на родительский объект. Унаследован от IChildOnMap.
setParent(parent)	IChildOnMap	Устанавливает родительский объект. Унаследован от IChildOnMap.

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

editor

{geometryEditor.LineString} editor

Редактор геометрии "Ломаная линия".

geometry

{geometry.LineString} geometry

Геометрия типа "Ломаная линия".