Polyline
Расширяет GeoObject.
Ломаная линия. Представляет собой геообъект с геометрией geometry.LineString.
См.: GeoObjectgeometry.LineString
Конструктор | Поля | События | Методы
Конструктор
Polyline(geometry[, properties[, options]])
Создает экземпляр ломаной.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number[][]|Object|ILineStringGeometry Координаты вершин, хэш-объект с параметрами геометрии или ссылка на объект геометрии ломаной линии. |
|
— |
Тип: Object|IDataManager Данные ломаной. Могут задаваться как экземпляр класса, реализующего интерфейс IDataManager, либо в виде хэша. При значениях опций по умолчанию геообъектом трактуются следующие поля данных:
|
|
— |
Тип: Object Опции ломаной. Используя этот параметр можно задавать как опции самой ломаной, так и опции ее составных частей:
|
|
"pointer" |
Тип: String Вид курсора над ломаной. |
|
false |
Тип: Boolean Определяет возможность перетаскивания ломаной. |
|
true |
Тип: Boolean Определяет наличие поля balloon у ломаной. |
|
true |
Тип: Boolean Определяет наличие поля hint у ломаной. |
|
false |
Тип: Boolean Включает режим автоматического изменения z-index ломаной в зависимости от ее состояния. |
|
"default#geoObject" |
Тип: String Модель интерактивности. Доступные ключи и их значения перечислены в описании interactivityModel.storage. |
|
"default#polyline" |
Тип: String|Function Ключ-идентификатор из хранилища overlay.storage или класс оверлея. Функция-генератор принимает три параметра:
|
|
1 |
Тип: Number Прозрачность. |
|
true |
Тип: Boolean Определяет, показывать ли балун при щелчке на ломаной. |
|
false |
Тип: Boolean Определяет, показывать ли пустой балун при щелчке на ломаной. |
|
false |
Тип: Boolean Определяет, показывать ли хинт при наведении указателя мыши на ломаную. |
|
true |
Тип: Boolean Определяет, показывать ли хинт при наведении указателя мыши на ломаную. |
|
"areas" |
Тип: IPane|String Ключ пейна, в который помещается оверлей ломаной. |
|
"0066ffff" |
Тип: String|String[] Цвет линии или обводки. Можно задать несколько значений для множественной обводки. |
|
1 |
Тип: Number|Number[] Прозрачность линии или обводки. Можно задать несколько значений для множественной обводки. |
|
— |
Тип: String|Object|String[]|Object[] Стиль линии или обводки. Доступные стили перечислены в объекте graphics.style.stroke. |
|
1 |
Тип: Number|Number[] Толщина линии или обводки. Можно задать несколько значений для множественной обводки. |
|
false |
Тип: Boolean Включает синхронное добавление оверлея на карту. По умолчанию добавление оверлея осуществляется асинхронно, что позволяет предотвратить зависания браузера при добавлении на карту большого числа ломаных. Однако, асинхронное добавление не позволяет получать доступ к оверлею сразу после добавления ломаной на карту. |
|
true |
Тип: Boolean При перетаскивании объекта к краю карты происходит автоматическое изменение центра карты. Нужно ли учитывать отступы карты при автоматическом смещении центра карты map.margin.Manager. |
|
true |
Тип: Boolean Определяет видимость ломаной. |
|
— |
Тип: Number z-index ломаной в обычном состоянии. Наименее приоритетный. |
|
— |
Тип: Number z-index ломаной с открытым балуном. Наиболее приоритетный. |
|
— |
Тип: Number z-index ломаной при перетаскивании. |
|
— |
Тип: Number z-index ломаной при наведении на него указателя мыши. |
* Обязательный параметр/опция.
Пример:
// Создадим ломаную.
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());
Поля
Имя |
Тип |
Описание |
Балун геообъекта. Унаследовано от GeoObject. |
||
Редактор геометрии "Ломаная линия". |
||
Менеджер событий. Унаследовано от GeoObject. |
||
Геометрия типа "Ломаная линия". |
||
Хинт геообъекта. Унаследовано от GeoObject. |
||
Менеджер опций геообъекта. Унаследовано от GeoObject. |
||
Менеджер данных геообъекта. Унаследовано от GeoObject. |
||
Состояние геообъекта. Определяется следующими полями:
Унаследовано от GeoObject. |
События
Имя |
Описание |
Закрытие балуна. Экземпляр класса Event. Унаследовано от GeoObject. |
|
Открытие балуна на геообъекте. Экземпляр класса Event. Унаследовано от GeoObject. |
|
Событие, предшествующее событию drag. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
|
Событие, предшествующее событию dragstart. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
|
Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Перетаскивание геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
|
Завершение перетаскивания геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
|
Начало перетаскивания геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
|
Изменение состояния редактора геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от GeoObject. |
|
Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
|
Закрытие хинта. Экземпляр класса Event. Унаследовано от GeoObject. |
|
Открытие хинта на геообъекте. Экземпляр класса Event. Унаследовано от GeoObject. |
|
Сменилась карта. Поля данных:
Унаследовано от IParentOnMap. |
|
Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
|
Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent. Унаследовано от IDomEventEmitter. |
|
Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
Унаследовано от IDomEventEmitter. |
|
Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
Унаследовано от IDomEventEmitter. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Изменение оверлея геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
|
Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
|
Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObject. |
|
Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter. |
Методы
Имя |
Возвращает |
Описание |
getMap() |
Возвращает ссылку на карту. Унаследован от IParentOnMap. |
|
Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки. Унаследован от IGeoObject. |
||
IOverlay|null |
Метод предоставляет синхронный доступ к оверлею. Унаследован от IGeoObject. |
|
IParentOnMap|null |
Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IChildOnMap. |
|
Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IChildOnMap. |
Описание полей
editor
{geometryEditor.LineString} editor
Редактор геометрии "Ломаная линия".
geometry
{geometry.LineString} geometry
Геометрия типа "Ломаная линия".
Обязательный параметр.