IPixelLineStringGeometry

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

Конструктор

IPixelLineStringGeometry()

Поля

Имя

Тип

Описание

events

IEventManager

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

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

Методы

Имя	Возвращает	Описание
equals(geometry)	Boolean	Возвращает true, если переданная геометрия эквивалентна данной. Унаследован от IPixelGeometry.
getBounds()	Number[][]\|null	Возвращает координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - угол с наименьшими значениями координат относительно остальных точек области; второй элемент - угол с наибольшими значениями координат. Унаследован от IBaseGeometry.
getClosest(anchorPosition)	Object	Ищет на ломаной линии точку, ближайшую к anchorPosition.
getCoordinates()	Number[][]	Возвращает координаты линии.
getLength()	Integer	Возвращает количество точек в геометрии.
getMetaData()	Object	Возвращает метаданные пиксельной геометрии. Унаследован от IPixelGeometry.
getType()	String	Возвращает идентификатор типа геометрии. Унаследован от IBaseGeometry.
scale(factor)	IPixelGeometry	Создает отмасштабированную копию геометрии. Унаследован от IPixelGeometry.
shift(offset)	IPixelGeometry	Создает копию геометрии сдвинутую на заданную величину. Унаследован от IPixelGeometry.

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

getClosest

{Object} getClosest(anchorPosition)

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

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

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

Параметры:

Параметр

Значение по умолчанию

Описание

anchorPosition*

—

Тип: Number[]

Координаты точки, для которой расчитывается ближайшая точка на ломаной.

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

getCoordinates

{Number[][]} getCoordinates()

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

getLength

{Integer} getLength()

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