Документация
Справочник JavaScript API
2.1.64 (текущая версия)
collection
interactivityModel
Интерфейсы

geometry.base.LineString

Расширяет IBaseLineStringGeometry.

Базовая геометрия "Ломаная линия".

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

Конструктор

geometry.base.LineString([coordinates])

Параметры:

ПараметрЗначение по умолчаниюОписание
coordinates []

Тип: Number[][]

Координаты геометрии.

Пример:

var lineString = new ymaps.geometry.base.LineString([
    [30, 50], [31, 51], [32, 52]
]);
//...
lineString.set(1, [20, 40]).remove(2);

Поля

ИмяТипОписание
events event.Manager

Менеджер событий геометрии.

События

ИмяОписание
change

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

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

Унаследовано от ILineStringGeometryAccess.

Методы

ИмяВозвращаетОписание
freeze()

IFreezable

Переводит объект в "замороженный" режим.

Унаследован от IFreezable.

get(index)

Number[]

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

Унаследован от ILineStringGeometryAccess.

getBounds()

Number[][]|null

Возвращает координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - угол с наименьшими значениями координат относительно остальных точек области; второй элемент - угол с наибольшими значениями координат.

Унаследован от IBaseGeometry.

getChildGeometry(index)

IPointGeometryAccess

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

Унаследован от ILineStringGeometryAccess.

getClosest(anchorPosition)

Object

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

Унаследован от ILineStringGeometryAccess.

getCoordinates()

Number[][]

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

Унаследован от ILineStringGeometryAccess.

getLength()

Integer

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

Унаследован от ILineStringGeometryAccess.

getType()

String

Возвращает строку "LineString".

Унаследован от IBaseLineStringGeometry.

insert(index, coordinates)

ILineStringGeometryAccess

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

Унаследован от ILineStringGeometryAccess.

isFrozen()

Boolean

Возвращает true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от IFreezable.

remove(index)

Number[]

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

Унаследован от ILineStringGeometryAccess.

set(index, coordinates)

ILineStringGeometryAccess

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

Унаследован от ILineStringGeometryAccess.

setCoordinates(coordinates)

ILineStringGeometryAccess

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

Унаследован от ILineStringGeometryAccess.

splice(index, number)

Number[][]

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

Унаследован от ILineStringGeometryAccess.

unfreeze()

IFreezable

Переводит объект в активный режим.

Унаследован от IFreezable.

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

events

{event.Manager} events

Менеджер событий геометрии.