---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelLineStringGeometry.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/llms.txt

# IPixelLineStringGeometry

Расширяет [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md).

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

## Конструктор {#constructor}

```javascript
IPixelLineStringGeometry(coordinates[, metaData])
```

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `coordinates`[*](*parametr) | — | Тип: Number[][]

Координаты линии. ||
|| `metaData` | — | Тип: Object

метаданные ||
|#

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

## Поля {#fields}

#|
|| **Имя** | **Тип** | **Описание** ||
|| [events](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events). ||
|#

## Методы {#methods}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getBounds](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBaseGeometry.md#getBounds)() | Number[][]\|null | Returns координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - угол с наименьшими значениями координат относительно остальных точек области; второй элемент - угол с наибольшими значениями координат.

Унаследован от [IBaseGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBaseGeometry.md#getBounds). ||
|| [getClosest](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelLineStringGeometry.md#getClosest)([anchorPosition](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelLineStringGeometry.md#getClosest-param-anchorPosition)) | Object | Ищет на ломаной линии точку, ближайшую к anchorPosition. ||
|| [getCoordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelLineStringGeometry.md#getCoordinates)() | Number[][] | Returns координаты линии. ||
|| [getLength](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelLineStringGeometry.md#getLength)() | Integer | Returns количество точек в геометрии. ||
|| [getMetaData](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md#getMetaData)() | Object | Returns метаданные пиксельной геометрии.

Унаследован от [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md#getMetaData). ||
|| [getType](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBaseGeometry.md#getType)() | String | Returns идентификатор типа геометрии.

Унаследован от [IBaseGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IBaseGeometry.md#getType). ||
|| [scale](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md#scale)([factor](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md#scale-param-factor)) | [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md) | Создает отмасштабированную копию геометрии.

Унаследован от [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md#scale). ||
|| [shift](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md#shift)([offset](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md#shift-param-offset)) | [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md) | Создает копию геометрии сдвинутую на заданную величину.

Унаследован от [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md#shift). ||
|#

## Описание методов {#description-methods}

### getClosest

```javascript
{Object} getClosest(anchorPosition)
```

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

**Returns** объект со следующими полями:

• position - точка на ломаной ближайшая к anchorPosition;

• distance - расстояние от anchorPosition до position;

• closestPointIndex - индекс вершины, ближайшей к position;

• nextPointIndex - индекс вершины, следующей за position;

• prevPointIndex - индекс вершины, предшествующей position.

Поля nextPointIndex, prevPointIndex могут отсутствовать, если position совпадает с одной из вершин ломаной линии.

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `anchorPosition`[*](*parametr) | — | Тип: Number[]

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


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

### getCoordinates

```javascript
{Number[][]} getCoordinates()
```

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

### getLength

```javascript
{Integer} getLength()
```

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