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

# YMaps.CoordPath

Множество вершин контура графического объекта с возможностью их распределения по коэффициентам масштабирования карты.
# Конструктор

Имя | Описание
----- | -----
[YMaps.CoordPath](coordpath.md#constructor)(vertices) | Создает объект для управления множеством вершин контура графического объекта.

# Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getIndexesByZoom](coordpath.md#getIndexesByZoom)(zoom) | Integer[] | Возвращает массив индексов вершин, которые должны отображаться при заданном коэффициенте масштабирования карты.
[getNumVertices](coordpath.md#getNumVertices)() | Integer | Возвращает число вершин в контуре графического объекта.
[getVertex](coordpath.md#getVertex)(index) | [YMaps.CoordVertex](coordvertex.md) | Возвращает вершину контура графического объекта по ее индексу.
[getVertices](coordpath.md#getVertices)() | [YMaps.CoordVertex](coordvertex.md)[] | Возвращает копию массива вершин контура графического объекта.
[setVertices](coordpath.md#setVertices)(vertices) |  | Устанавливает вершины контура графического объекта.
[spliceVertices](coordpath.md#spliceVertices)(index, number) | [YMaps.CoordVertex](coordvertex.md)[] | Удаляет вершины из контура графического объекта. Если необходимо, вставляет на их место другие вершины.

## Подробное описание конструктора {#constructor}

```javascript
YMaps.CoordPath(vertices)
```

Создает объект для управления множеством вершин контура графического объекта.

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

Имя | Тип | Описание
----- | ----- | -----
`vertices` | [YMaps.CoordVertex](coordvertex.md)[] | Массив вершин контура графического объекта.

## Подробное описание методов {#method_detail}
### getIndexesByZoom {#getIndexesByZoom}

```javascript
{Integer[]} getIndexesByZoom(zoom)
```

Возвращает массив индексов вершин, которые должны отображаться при заданном коэффициенте масштабирования карты.

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

Имя | Тип | Описание
----- | ----- | -----
`zoom` | Integer | Значение коэффициента масштабирования карты, для которого производится выборка индексов.


**Возвращает:**

Тип | Описание
----- | -----
Integer[] | Массив индексов видимых вершин контура.

### getNumVertices {#getNumVertices}

```javascript
{Integer} getNumVertices()
```

Возвращает число вершин в контуре графического объекта.

**Возвращает:**

Тип | Описание
----- | -----
Integer | Число вершин в контуре графического объекта.

### getVertex {#getVertex}

```javascript
{YMaps.CoordVertex} getVertex(index)
```

Возвращает вершину контура графического объекта по ее индексу.

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

Имя | Тип | Описание
----- | ----- | -----
`index` | Integer | Индекс вершины контура графического объекта.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.CoordVertex](coordvertex.md) | Ссылка на вершину.

### getVertices {#getVertices}

```javascript
{YMaps.CoordVertex[]} getVertices()
```

Возвращает копию массива вершин контура графического объекта.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.CoordVertex](coordvertex.md)[] | Массив вершин контура графического объекта.

### setVertices {#setVertices}

```javascript
setVertices(vertices)
```

Устанавливает вершины контура графического объекта.

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

Имя | Тип | Описание
----- | ----- | -----
`vertices` | [YMaps.CoordVertex](coordvertex.md)[] | Массив вершин.

### spliceVertices {#spliceVertices}

```javascript
{YMaps.CoordVertex[]} spliceVertices(index, number)
```

Удаляет вершины из контура графического объекта. Если необходимо, вставляет на их место другие вершины.

Вершины, которые будут вставлены вместо удаленных, передаются как дополнительные параметры после параметра `number`.

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

Имя | Тип | Описание
----- | ----- | -----
`index` | Integer | Индекс первой удаляемой вершины.
`number` | Integer | Количество удаляемых вершин.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.CoordVertex](coordvertex.md)[] | Массив удаленных вершин.