IPixelLineStringGeometry

Расширяет IPixelGeometry.

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

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

Конструктор

IPixelLineStringGeometry(coordinates[, metaData])

Параметры:

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

Тип: Number[][]

Координаты линии.
metaData —

Тип: Object

метаданные
Параметр Значение по умолчанию Описание
coordinates * —

Тип: Number[][]

Координаты линии.
metaData —

Тип: Object

метаданные

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

Поля

Имя Тип Описание
events IEventManager

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

Унаследовано от IEventEmitter.
Имя Тип Описание
events IEventManager

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

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

Методы

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

Number[][]|null

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

Унаследован от IBaseGeometry.
getClosest(anchorPosition)

Object

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

Number[][]

Returns координаты линии.
getLength()

Integer

Returns количество точек в геометрии.
getMetaData()

Object

Returns метаданные пиксельной геометрии.

Унаследован от IPixelGeometry.
getType()

String

Returns идентификатор типа геометрии.

Унаследован от IBaseGeometry.
scale(factor)

IPixelGeometry

Создает отмасштабированную копию геометрии.

Унаследован от IPixelGeometry.
shift(offset)

IPixelGeometry

Создает копию геометрии сдвинутую на заданную величину.

Унаследован от IPixelGeometry.
Имя Возвращает Описание
getBounds()

Number[][]|null

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

Унаследован от IBaseGeometry.
getClosest(anchorPosition)

Object

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

Number[][]

Returns координаты линии.
getLength()

Integer

Returns количество точек в геометрии.
getMetaData()

Object

Returns метаданные пиксельной геометрии.

Унаследован от IPixelGeometry.
getType()

String

Returns идентификатор типа геометрии.

Унаследован от IBaseGeometry.
scale(factor)

IPixelGeometry

Создает отмасштабированную копию геометрии.

Унаследован от IPixelGeometry.
shift(offset)

IPixelGeometry

Создает копию геометрии сдвинутую на заданную величину.

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

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

getClosest

{Object} getClosest(anchorPosition)

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

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

Параметры:

Параметр Значение по умолчанию Описание
anchorPosition * —

Тип: Number[]

Координаты точки, для которой расчитывается ближайшая точка на ломаной.
Параметр Значение по умолчанию Описание
anchorPosition * —

Тип: Number[]

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

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

getCoordinates

{Number[][]} getCoordinates()

Returns координаты линии.

getLength

{Integer} getLength()

Returns количество точек в геометрии.