ILineStringGeometryAccess

Расширяет IFreezable.

Интерфейс доступа к геометрии "Ломаная линия".

Конструктор | Поля | События | Методы

Конструктор

ILineStringGeometryAccess()

Поля

События

Методы

Описание событий

change

Изменение координат. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

• oldCoordinates — старые координаты;
• newCoordinates - новые координаты;

Описание методов

get

{Number[]} get(index)

Возвращает координаты точки с заданным индексом.

Параметры:

* Обязательный параметр/опция.

Пример:

// Отмечаем начало линии меткой:
map.geoObjects.add(
    new ymaps.Placemark(polyline.geometry.get(0), { iconContent: 'A' })
);

getChildGeometry

{IPointGeometryAccess} getChildGeometry(index)

Создает и возвращает объект IPointGeometryAccess для заданной вершины ломаной линии.

Возвращает объект геометрии "Точка", соответствующий заданной вершине.

Параметры:

* Обязательный параметр/опция.

getClosest

{Object} getClosest(anchorPosition)

Ищет на ломаной линии точку, ближайшую к anchorPosition.

Возвращает объект со следующими полями:

• position - точка на ломаной ближайшая к anchorPosition;
• distance - расстояние от anchorPosition до position;
• closestPointIndex - индекс вершины, ближайшей к position;
• nextPointIndex - индекс вершины, следующей за position;
• prevPointIndex - индекс вершины, предшествующей position.
  Поля nextPointIndex, prevPointIndex могут отсутствовать, если position совпадает с одной из вершин ломаной линии.

Параметры:

* Обязательный параметр/опция.

Пример:

// Удаляем из линии точки по клику на ней:
myPolyline.events.add('click', function (e) {
    myPolyline.geometry.remove(
        myPolyline.geometry.getClosest(e.get('coords')).closestPointIndex
    );
});

getCoordinates

{Number[][]} getCoordinates()

Возвращает массив координат геометрии.

getLength

{Integer} getLength()

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

insert

{ILineStringGeometryAccess} insert(index, coordinates)

Добавляет новую точку с заданным индексом.

Возвращает ссылку на себя.

Параметры:

* Обязательный параметр/опция.

Пример:

// Добавляем новую точку в конце линии по клику на карте.
myMap.events.add('click', function (e) {
    myLineString.insert(myLineString.getLength(), e.get('coords'));
});

remove

{Number[]} remove(index)

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

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

Параметры:

* Обязательный параметр/опция.

set

{ILineStringGeometryAccess} set(index, coordinates)

Задает координаты точки c заданным индексом.

Возвращает ссылку на себя.

Параметры:

* Обязательный параметр/опция.

setCoordinates

{ILineStringGeometryAccess} setCoordinates(coordinates)

Задает массив координат геометрии.

Возвращает ссылку на себя.

Параметры:

* Обязательный параметр/опция.

splice

{Number[][]} splice(index, number)

Удаляет определенное число точек начиная с заданного индекса. При этом на место удаляемых точек могут быть добавлены новые. Координаты новых точек можно передавать дополнительными аргументами после параметра number.

Возвращает массив координат удаленных точек.

Параметры:

* Обязательный параметр/опция.

Пример:

// Добавляем новую точку в начало линии по клику на карте.
myMap.events.add('click', function (e) {
    myLineString.splice(0, 0, myLineString.getLength(), e.get('coords'));
});