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

# IPixelLineStringGeometry

Extends [IPixelGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md).

Interface for the "Polyline" pixel geometry.

[Constructor](#constructor-summary) | [Fields](#properties-summary) | [Methods](#methods-summary)

## Constructor {#constructor-summary}

```javascript
IPixelLineStringGeometry()
```

## Fields {#properties-summary}

#|
|| **Name** | **Type** | **Description** ||
|| [events](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventManager.md) | Event manager.

Inherited from [IEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events). ||
|#

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [equals](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#equals)([geometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#equals-param-geometry)) | Boolean | Returns true if the passed geometry is equivalent to the given one.

Inherited from [IPixelGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#equals). ||
|| [getBounds](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBaseGeometry.md#getBounds)() | Number[][]\|null | Returns coordinates of the two opposite corners of the area that surrounds the geometry. The first item in the array is the corner with the smallest coordinate values relative to the rest of the points in the area; the second item is the corner with the largest coordinate values.

Inherited from [IBaseGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBaseGeometry.md#getBounds). ||
|| [getClosest](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelLineStringGeometry.md#getClosest)([anchorPosition](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelLineStringGeometry.md#getClosest-param-anchorPosition)) | Object | Searches for a point on the polyline closest to the anchorPosition. ||
|| [getCoordinates](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelLineStringGeometry.md#getCoordinates)() | Number[][] | Returns coordinates of a line. ||
|| [getLength](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelLineStringGeometry.md#getLength)() | Integer | Returns the number of points in the geometry. ||
|| [getMetaData](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#getMetaData)() | Object | Returns metadata of the pixel geometry.

Inherited from [IPixelGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#getMetaData). ||
|| [getType](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBaseGeometry.md#getType)() | String | Returns ID of the geometry type.

Inherited from [IBaseGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBaseGeometry.md#getType). ||
|| [scale](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#scale)([factor](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#scale-param-factor)) | [IPixelGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md) | Creates a scaled copy of the geometry.

Inherited from [IPixelGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#scale). ||
|| [shift](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#shift)([offset](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#shift-param-offset)) | [IPixelGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md) | Creates a copy of the geometry that is shifted by the specified amount.

Inherited from [IPixelGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md#shift).||
|#

## Methods details {#method_detail}

### getClosest {#getClosest}

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

Searches for a point on the polyline closest to the anchorPosition.

**Returns** an object with the following fields: 
- position - Point on the polyline closest to "anchorPosition".
- distance - Distance from "anchorPosition" to "position".
- closestPointIndex - Index of the vertex closest to "position".
- nextPointIndex - Index of the vertex that follows "position".
- prevPointIndex - Index of the vertex that precedes "position".
The "nextPointIndex" and "prevPointIndex" fields may be omitted if "position" coincides with one of the polyline vertexes.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`anchorPosition`](#getClosest-param-anchorPosition)[*](*star) | — | Type: Number[]

Coordinates of a point for which the nearest polyline vertex is calculated. ||
|#

\* Mandatory parameter/option.

### getCoordinates {#getCoordinates}

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

**Returns** coordinates of a line.

### getLength {#getLength}

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

**Returns** the number of points in the geometry.

[*star]: Mandatory parameter/option.