YMaps.Polyline

Расширяет YMaps.IInteractiveGeoObject, YMaps.IOverlay.

Ломаная линия.

См.: Ломаная

Конструктор

Поля

Наследуемые поля

Из YMaps.IGeoObject:

description, id, metaDataProperty, name

События

Методы

Имя	Статический	Возвращает	Описание
addPoint(point, index)			Добавляет одну или несколько вершин в линию. По умолчанию вершины добавляются в конец линии.
fromEncodedPoints(encodedPoints, levels, options, coordSystem)		YMaps.Polyline	Создает ломаную линию из массива ее вершин, закодированных в Base64.
getClosestPoint(anchorPoint)		Object	null
getCoordPath()		YMaps.CoordPath	Возвращает объект, управляющий множеством вершин ломаной линии.
getEditingOptions()		YMaps.PolylineEditingOptions	Возвращает опции режима редактирования ломаной линии.
getMap()		YMaps.Map	Возвращает указатель на карту, в которую добавлена ломаная линия.
getNumPoints()		Integer	Возвращает количество вершин в ломаной линии.
getOptions()		YMaps.PolylineOptions	Возвращает опции ломаной линии.
getPixelPoints(options)		YMaps.Point[]	Возвращает информацию об отображении контуров ломаной линии.
getPoint(index)		YMaps.ICoordPoint	Возвращает координаты вершины по ее индексу.
getPoints()		YMaps.ICoordPoint[]	Возвращает координаты вершин линии.
isDrawing()		Boolean	Проверяет, находится ли ломаная линия в режиме рисования.
isEditing()		Boolean	Проверяет, находится ли ломаная линия в режиме редактирования.
removePoint(index)		YMaps.ICoordPoint	Удаляет из линии вершину с заданным индексом.
setEditingOptions(options)			Устанавливает опции режима редактирования ломаной линии.
setOptions(options, restoreDefault)			Устанавливает опции ломаной линии.
setPoints(points)			Устанавливает координаты вершин линии.
splicePoints(index, number)		YMaps.ICoordPoint[]	Удаляет вершины из ломаной линии. Если необходимо, вставляет на их место другие вершины. Координаты вершин, которые будут вставлены вместо удаленных, передаются как дополнительные параметры после параметра number.
startEditing()			Включает режим редактирования ломаной линии.
stopEditing()			Отключает режим редактирования ломаной линии.

Наследуемые методы

Из YMaps.IOverlay:

onAddToMap, onMapUpdate, onRemoveFromMap

Из YMaps.IInteractiveGeoObject:

closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions, openBalloon, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions, update

Из YMaps.IGeoObject:

getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup, setBounds, setStyle

Подробное описание конструктора

YMaps.Polyline(path, options)

Создает ломаную линию.

См.: Ломаная

Пример:

// 
var line = new YMaps.Polyline([
    new YMaps.GeoPoint(37.77751,55.76578),
    new YMaps.GeoPoint(37.67751,55.86578),
    new YMaps.GeoPoint(37.41321,55.92685)
], {
    geodesic: true
});
map.addOverlay(line);

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
path	YMaps.ICoordPoint[]	YMaps.CoordPath
options	YMaps.PolylineOptions			Опции ломаной линии.

Подробное описание полей

Events

Object Events

Список обрабатываемых событий ломаной линии.

Подробное описание событий

AddToMap

AddToMap

Добавление ломаной линии на карту.

В callback-функцию передается указатель на линию, для которой был вызван обработчик.

BalloonClose

BalloonClose

Закрытие балуна, открытого над ломаной линией.

В callback-функцию передается указатель на линию, для которой был вызван обработчик.

BalloonOpen

BalloonOpen

Открытие балуна ломаной линии.

В callback-функцию передается указатель на линию, для которой был вызван обработчик.

Click

Click

Щелчок мыши по ломаной линии.

В callback-функцию передаются два аргумента:

• указатель на линию, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

DblClick

DblClick

Двойной щелчок мыши по ломаной линии.

В callback-функцию передаются два аргумента:

• указатель на линию, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

Drag

Drag

Продолжается перетаскивание ломаной линии.

В callback-функцию передаются два аргумента:

• указатель на ломаную линию, для которой был вызван обработчик;
• объект YMaps.Point со значением смещения ломаной линии в пикселах относительно ее предыдущего положения.

DragEnd

DragEnd

Закончено перетаскивание ломаной линии.

В callback-функцию передается указатель на ломаную линию, для которой был вызван обработчик.

DragStart

DragStart

Началось перетаскивание ломаной линии (если разрешено).

В callback-функцию передается указатель на ломаную линию, для которой был вызван обработчик.

MouseEnter

MouseEnter

Курсор наведен на ломаную линию.

В callback-функцию передаются два аргумента:

• указатель на линию, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

MouseLeave

MouseLeave

Курсор убран с ломаной линии.

В callback-функцию передаются два аргумента:

• указатель на линию, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

MouseMove

MouseMove

Движение курсора мышкой в пределах ломаной линии.

В callback-функцию передаются два аргумента:

• указатель на линию, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

PositionChange

PositionChange

Изменение координат линии (например, с помощью метода YMaps.Polyline.addPoint).

В callback-функцию передается указатель на линию, для которой был вызван обработчик.

RemoveFromMap

RemoveFromMap

Удаление ломаной линии с карты.

В callback-функцию передается указатель на линию, для которой был вызван обработчик.

StartDrawing

StartDrawing

Включение режима добавления вершин в линию.

В callback-функцию передается указатель на линию, для которой был вызван обработчик.

StartEditing

StartEditing

Включение режима редактирования линии.

В callback-функцию передается указатель на линию, для которой был вызван обработчик.

StopDrawing

StopDrawing

Отключение режима добавления вершин в линию.

В callback-функцию передается указатель на линию, для которой был вызван обработчик.

StopEditing

StopEditing

Отключение режима редактирования линии.

В callback-функцию передается указатель на линию, для которой был вызван обработчик.

Подробное описание методов

AddPoint

addPoint(point, index)

Добавляет одну или несколько вершин в линию. По умолчанию вершины добавляются в конец линии.

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
point	YMaps.ICoordPoint	YMaps.ICoordPoint[]
index	Integer			Позиция, в которую нужно добавить вершину.

fromEncodedPoints

{YMaps.Polyline} fromEncodedPoints(encodedPoints, levels, options, coordSystem)

Создает ломаную линию из массива ее вершин, закодированных в Base64.

См.: Ломаная

Пример:

// 
map.setCenter(new YMaps.GeoPoint(37.619, 55.753), 1);
var polyline = YMaps.Polyline.fromEncodedPoints(
    "-4aTAwItMQEI087-vuHkAICWmAA7S0wA_9LO_kNLTAABLTEBQUtMAIBpZ_8_S0wA-CwxAUBLTAAI087-PUtMAICWmABBS0wA_9LO_j5LTAA=",
    "BCCBCCBCCB"
);
map.addOverlay(polyline);

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
encodedPoints	String			Закодированные координаты вершин линии.
levels	String			Строка кодов уровней. Для каждой вершины ломаной указывается масштаб, начиная с которого вершина становится не видна.
options	YMaps.PolylineOptions			Опции ломаной линии.
coordSystem	YMaps.ICoordSystem		YMaps.GeoCoordSystem	Ссылка на координатную систему.

Возвращает:

getClosestPoint

{Object|null} getClosestPoint(anchorPoint)

Ищет на ломаной линии точку, ближайшую к anchorPoint. Возвращает объект, содержащий координаты ближайшей точки и индекс начальной вершины сегмента ломаной, на котором лежит найденная точка. Если ломаная не содержит точек, возвращает null.
Пример:

var line = new YMaps.Polyline([
    new YMaps.GeoPoint(0, 0),
    new YMaps.GeoPoint(0, 20),
    new YMaps.GeoPoint(20, 20)
]);

map.addOverlay(line);

var closest = line.getClosestPoint(
    new YMaps.GeoPoint(-5, 10)
);

// closest.point будет содержать экземпляр YMaps.GeoPoint с координатами 0, 10.
// closest.index будет содержать 0.

Параметры:

Возвращает:

getCoordPath

{YMaps.CoordPath} getCoordPath()

Возвращает объект, управляющий множеством вершин ломаной линии.

Возвращает:

getEditingOptions

{YMaps.PolylineEditingOptions} getEditingOptions()

Возвращает опции режима редактирования ломаной линии.

Возвращает:

getMap

{YMaps.Map} getMap()

Возвращает указатель на карту, в которую добавлена ломаная линия.

Возвращает:

getNumPoints

{Integer} getNumPoints()

Возвращает количество вершин в ломаной линии.

Возвращает:

getOptions

{YMaps.PolylineOptions} getOptions()

Возвращает опции ломаной линии.

Возвращает:

getPixelPoints

{YMaps.Point[]} getPixelPoints(options)

Возвращает информацию об отображении контуров ломаной линии.

Параметры:

Возвращает:

getPoint

{YMaps.ICoordPoint} getPoint(index)

Возвращает координаты вершины по ее индексу.

Параметры:

Возвращает:

getPoints

{YMaps.ICoordPoint[]} getPoints()

Возвращает координаты вершин линии.

Возвращает:

isDrawing

{Boolean} isDrawing()

Проверяет, находится ли ломаная линия в режиме рисования.

Возвращает:

isEditing

{Boolean} isEditing()

Проверяет, находится ли ломаная линия в режиме редактирования.

Возвращает:

removePoint

{YMaps.ICoordPoint} removePoint(index)

Удаляет из линии вершину с заданным индексом.

Параметры:

Возвращает:

setEditingOptions

setEditingOptions(options)

Устанавливает опции режима редактирования ломаной линии.

Параметры:

setOptions

setOptions(options, restoreDefault)

Устанавливает опции ломаной линии.

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
options	YMaps.PolylineOptions			Опции ломаной линии.
restoreDefault	Boolean		false	Незаданные опции установить в значения по умолчанию.

setPoints

setPoints(points)

Устанавливает координаты вершин линии.

Параметры:

splicePoints

{YMaps.ICoordPoint[]} splicePoints(index, number)

Удаляет вершины из ломаной линии. Если необходимо, вставляет на их место другие вершины. Координаты вершин, которые будут вставлены вместо удаленных, передаются как дополнительные параметры после параметра number.
Примеры:

1.

// Удаляет вторую вершину ломаной.
polyline.splicePoints(1, 1);

2.

// Вставляет новую вершину во вторую позицию.
polyline.splicePoints(1, 0, new YMaps.GeoPoint(37.63, 55.75));

3.

// Заменяет вторую вершину ломаной на новую.
polyline.splicePoints(1, 1, new YMaps.GeoPoint(37.63, 55.75));

Параметры:

Возвращает:

startEditing

startEditing()

Включает режим редактирования ломаной линии. Должен вызываться после добавления ломаной на карту.

stopEditing

stopEditing()

Отключает режим редактирования ломаной линии.