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

# ILineStringGeometryAccess

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

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

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

```javascript
ILineStringGeometryAccess()
```

## Поля {#fields}

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

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

## События {#events}

#|
|| **Имя** | **Описание** ||
|| [change](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#change) | Изменение координат. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get:

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

• newCoordinates - новые координаты. ||
|#

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [freeze](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#freeze)() | [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md) | Переводит объект в "замороженный" режим.

Унаследован от [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#freeze). ||
|| [get](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#get)([index](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#get-param-index)) | Number[] | Returns координаты точки с заданным индексом. ||
|| [getChildGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#getChildGeometry)([index](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#getChildGeometry-param-index)) | [IPointGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPointGeometryAccess.md) | Создает и возвращает объект [IPointGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPointGeometryAccess.md) для заданной вершины ломаной линии. ||
|| [getClosest](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#getClosest)([anchorPosition](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#getClosest-param-anchorPosition)) | Object | Ищет на ломаной линии точку, ближайшую к anchorPosition. ||
|| [getCoordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#getCoordinates)() | Number[][] | Returns массив координат геометрии. ||
|| [getLength](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#getLength)() | Integer | Returns количество точек в геометрии. ||
|| [insert](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#insert)([index](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#insert-param-index), [coordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#insert-param-coordinates)) | [ILineStringGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md) | Добавляет новую точку с заданным индексом. ||
|| [isFrozen](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#isFrozen)() | Boolean | Returns true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#isFrozen). ||
|| [remove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#remove)([index](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#remove-param-index)) | Number[] | Удаляет точку с заданным индексом. ||
|| [set](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#set)([index](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#set-param-index), [coordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#set-param-coordinates)) | [ILineStringGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md) | Задает координаты точки c заданным индексом. ||
|| [setCoordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#setCoordinates)([coordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#setCoordinates-param-coordinates)) | [ILineStringGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md) | Задает массив координат геометрии. ||
|| [splice](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#splice)([index](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#splice-param-index), [number](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILineStringGeometryAccess.md#splice-param-number)) | Number[][] | Удаляет определенное число точек начиная с заданного индекса. При этом на место удаляемых точек могут быть добавлены новые. Координаты новых точек можно передавать дополнительными аргументами после параметра number. ||
|| [unfreeze](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#unfreeze)() | [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md) | Переводит объект в активный режим.

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

## Описание событий {#description-events}

### change

Изменение координат. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get:

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

• newCoordinates - новые координаты.

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

### get

```javascript
{Number[]} get(index)
```

**Returns** координаты точки с заданным индексом.

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

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

Индекс точки. ||
|#

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

**Пример:**

```javascript
// Отмечаем начало линии меткой:
map.geoObjects.add(
    new ymaps.Placemark(polyline.geometry.get(0), { iconContent: 'A' })
);
```

### getChildGeometry

```javascript
{IPointGeometryAccess} getChildGeometry(index)
```

Создает и возвращает объект [IPointGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPointGeometryAccess.md) для заданной вершины ломаной линии.

**Returns** объект геометрии "Точка", соответствующий заданной вершине.

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

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

Индекс вершины. ||
|#

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

### getClosest

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

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

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

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

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

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

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

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

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

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

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

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

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

**Пример:**

```javascript
// Удаляем из линии точки по клику на ней:
myPolyline.events.add('click', function (e) {
    myPolyline.geometry.remove(
        myPolyline.geometry.getClosest(e.get('coordPosition')).closestPointIndex
    );
});
```

### getCoordinates

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

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

### getLength

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

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

### insert

```javascript
{ILineStringGeometryAccess} insert(index, coordinates)
```

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

**Returns** ссылку на себя.

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

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

Индекс точки. ||
|| `coordinates`[*](*parametr) | — | Тип: Number[]

Координаты точки. ||
|#

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

**Пример:**

```javascript
// добавляем новую точку в конце линии по клику на карте
myMap.events.add('click', function (e) {
    myLineString.insert(myLineString.getLength(), e.get('coordPosition'))
});
```

### remove

```javascript
{Number[]} remove(index)
```

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

**Returns** координаты удаленной точки.

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

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

Индекс точки. ||
|#

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

### set

```javascript
{ILineStringGeometryAccess} set(index, coordinates)
```

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

**Returns** ссылка на себя.

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

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

Индекс точки. ||
|| `coordinates`[*](*parametr) | — | Тип: Number[]

Координаты точки. ||
|#

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

### setCoordinates

```javascript
{ILineStringGeometryAccess} setCoordinates(coordinates)
```

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

**Returns** ссылка на себя.

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

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

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

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

### splice

```javascript
{Number[][]} splice(index, number)
```

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

**Returns** массив координат удаленных точек.

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

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

Индекс, начиная с которого производится удаление и добавление точек. ||
|| `number`[*](*parametr) | — | Тип: Integer

Количество удаляемых точек. ||
|#


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

**Пример:**

```javascript
// добавляем новую точку в начало линии по клику на карте
myMap.events.add('click', function (e) {
    myLineString.splice(0, 0, myLineString.getLength(), e.get('coordPosition'))
});
```

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