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

# YMaps.Polygon

Расширяет [YMaps.IInteractiveGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md), [YMaps.IOverlay](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md).

Многоугольник.
## Конструктор

Имя | Описание
----- | -----
[YMaps.Polygon](polygon.md#constructor)(path, options) | Создает многоугольник.


## Поля

Имя | Описание
----- | -----
[Events](polygon.md#Events) | Список обрабатываемых событий.

## Наследуемые поля

Из [YMaps.IGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md): 
: [description](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#description), [id](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#id), [metaDataProperty](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#metaDataProperty), [name](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#name)

## События

Имя | Описание
----- | -----
[AddToMap](polygon.md#event-AddToMap) | Добавление многоугольника на карту.
[BalloonClose](polygon.md#event-BalloonClose) | Закрытие балуна многоугольника.
[BalloonOpen](polygon.md#event-BalloonOpen) | Открытие балуна многоугольника.
[Click](polygon.md#event-Click) | Щелчок левой кнопкой мыши.
[DblClick](polygon.md#event-DblClick) | Двойной щелчок левой кнопкой мыши.
[Drag](polygon.md#event-Drag) | Продолжается перетаскивание многоугольника.
[DragEnd](polygon.md#event-DragEnd) | Закончено перетаскивание многоугольника.
[DragStart](polygon.md#event-DragStart) | Началось перетаскивание многоугольника (если разрешено).
[MouseEnter](polygon.md#event-MouseEnter) | Курсор наведен на многоугольник.
[MouseLeave](polygon.md#event-MouseLeave) | Курсор убран с многоугольника.
[MouseMove](polygon.md#event-MouseMove) | Движение курсора в пределах многоугольника.
[PositionChange](polygon.md#event-PositionChange) | Изменение координат многоугольника (например, с помощью метода [YMaps.Polygon.addPoint](polygon.md#addPoint)).
[RemoveFromMap](polygon.md#event-RemoveFromMap) | Удаление многоугольника с карты.
[StartDrawing](polygon.md#event-StartDrawing) | Включение режима добавления вершин многоугольника.
[StartEditing](polygon.md#event-StartEditing) | Включение режима редактирования многоугольника.
[StopDrawing](polygon.md#event-StopDrawing) | Отключение режима добавления вершин многоугольника.
[StopEditing](polygon.md#event-StopEditing) | Отключение режима редактирования многоугольника.

## Методы

Имя | Статический | Возвращает | Описание
----- | ----- | ----- | -----
[addPoint](polygon.md#addPoint)(point, index) |  |  | Добавляет одну или несколько вершин в многоугольник. По умолчанию вершины добавляются после вершины с максимальным индексом.
[contains](polygon.md#contains)(coordPoint) |  | Boolean | Определяет находится ли визуально точка `coordPoint` внутри многоугольника.
[fromEncodedPoints](polygon.md#.fromEncodedPoints)(encodedPoints, levels, options, coordSystem) | ![](../_images/check.png) | [YMaps.Polygon](polygon.md) | Строит многоугольник из закодированных в Base64 координат его вершин с учетом указанного для каждой вершины уровня видимости.
[getClosestPoint](polygon.md#getClosestPoint)(anchorPoint) |  | Object|null | Ищет на контуре многоугольника точку, ближайшую к `anchorPoint`. Возвращает объект, содержащий координаты ближайшей точки и индекс начальной вершины стороны многоугольника, на которой лежит найденная точка. Если многоугольник не содержит точек, возвращает null.
[getCoordPath](polygon.md#getCoordPath)() |  | [YMaps.CoordPath](coordpath.md) | Возвращает объект, управляющий множеством вершин внешнего контура многоугольника.
[getEditingOptions](polygon.md#getEditingOptions)() |  | [YMaps.PolygonEditingOptions](polygoneditingoptions.md) | Возвращает опции режима редактирования многоугольника.
[getMap](polygon.md#getMap)() |  | [YMaps.Map](map.md) | Возвращает указатель на карту, в которую добавлен многоугольник.
[getNumPoints](polygon.md#getNumPoints)() |  | Integer | Возвращает количество вершин многоугольника.
[getOptions](polygon.md#getOptions)() |  | [YMaps.PolygonOptions](polygonoptions.md) | Возвращает опции многоугольника.
[getPixelPoints](polygon.md#getPixelPoints)(options) |  | [YMaps.Point](point.md)[][] | Возвращает информацию об отображении контуров многоугольника.
[getPoint](polygon.md#getPoint)(index) |  | [YMaps.ICoordPoint](icoordpoint.md) | Возвращает вершину многоугольника с заданным индексом.
[getPoints](polygon.md#getPoints)() |  | [YMaps.ICoordPoint](icoordpoint.md)[] | Возвращает координаты вершин многоугольника.
[isDrawing](polygon.md#isDrawing)() |  | Boolean | Проверяет, находится ли многоугольник в режиме рисования.
[isEditing](polygon.md#isEditing)() |  | Boolean | Проверяет, находится ли многоугольник в режиме редактирования.
[removePoint](polygon.md#removePoint)(index) |  | [YMaps.ICoordPoint](icoordpoint.md) | Удаляет из многоугольника вершину с заданным индексом.
[setEditingOptions](polygon.md#setEditingOptions)(options) |  |  | Устанавливает опции режима редактирования многоугольника.
[setOptions](polygon.md#setOptions)(options, restoreDefault) |  |  | Устанавливает опции многоугольника.
[setPoints](polygon.md#setPoints)(points) |  |  | Устанавливает координаты вершин многоугольника.
[splicePoints](polygon.md#splicePoints)(index, number) |  | [YMaps.ICoordPoint](icoordpoint.md)[] | Удаляет заданные вершины многоугольника. Если требуется, вставляет на место удаленных другие вершины, которые передаются в метод дополнительными параметрами (после параметра number).
[startEditing](polygon.md#startEditing)() |  |  | Включает режим редактирования многоугольника.
[stopEditing](polygon.md#stopEditing)() |  |  | Отключает режим редактирования многоугольника.

## Наследуемые методы

Из [YMaps.IOverlay](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md): 
: [onAddToMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onAddToMap), [onMapUpdate](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onMapUpdate), [onRemoveFromMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onRemoveFromMap)

Из [YMaps.IInteractiveGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md): 
: [closeBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#closeBalloon), [getBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getBalloon), [getBalloonContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getBalloonContent), [getBalloonOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getBalloonOptions), [getHintContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getHintContent), [getHintOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getHintOptions), [openBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#openBalloon), [setBalloonContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setBalloonContent), [setBalloonOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setBalloonOptions), [setHintContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setHintContent), [setHintOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setHintOptions), [update](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#update)

Из [YMaps.IGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md): 
: [getBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getBounds), [getComputedStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getComputedStyle), [getParentGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getParentGroup), [getStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getStyle), [onAddToGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#onAddToGroup), [onRemoveFromGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#onRemoveFromGroup), [setBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#setBounds), [setStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#setStyle)

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

```javascript
YMaps.Polygon(path, options)
```

Создает многоугольник.

**Пример:**

```javascript
//  
var style = new YMaps.Style("default#greenPoint");
style.polygonStyle = new YMaps.PolygonStyle();
style.polygonStyle.fill = 1;
style.polygonStyle.outline = 1;
style.polygonStyle.strokeWidth = 10;
style.polygonStyle.strokeColor = "ffff0088";
style.polygonStyle.fillColor = "ff000055";
YMaps.Styles.add("polygon#Example", style);

var polygon = new YMaps.Polygon([
    new YMaps.GeoPoint(37.59507,55.576559),
    new YMaps.GeoPoint(37.493452,55.613885),
    new YMaps.GeoPoint(37.369853,55.767479),
    new YMaps.GeoPoint(37.405561,55.871082),
    new YMaps.GeoPoint(37.553873,55.911209),
    new YMaps.GeoPoint(37.707682,55.898866),
    new YMaps.GeoPoint(37.83677,55.821634),
    new YMaps.GeoPoint(37.834021,55.689979),
    new YMaps.GeoPoint(37.83677,55.646518),
    new YMaps.GeoPoint(37.669234,55.576559)
], {
    style: "polygon#Example",
    hasHint: 1,
    hasBalloon: 1
});

polygon.name = "Москва";
polygon.description = "Столица России"; 

map.addOverlay(polygon);
```

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`path` | [YMaps.ICoordPoint](icoordpoint.md)[]|YMaps.CoordPath |  |  | Массив координат, либо указатель на объект типа [YMaps.CoordPath](coordpath.md), определяющий набор вершин внешнего контура многоугольника.
`options` | [YMaps.PolygonOptions](polygonoptions.md) | ![](../_images/check.png) |  | Опции многоугольника.

## Подробное описание полей {#field_detail}

### Events {#Events}

```javascript
Object Events
```

Список обрабатываемых событий.

## Подробное описание событий {#event_detail}

### AddToMap {#AddToMap}

```javascript
AddToMap
```

Добавление многоугольника на карту.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### BalloonClose {#BalloonClose}

```javascript
BalloonClose
```

Закрытие балуна многоугольника.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### BalloonOpen {#BalloonOpen}

```javascript
BalloonOpen
```

Открытие балуна многоугольника.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### Click {#Click}

```javascript
Click
```

Щелчок левой кнопкой мыши.

В callback-функцию передаются:

- указатель на многоугольник, для которого был вызван обработчик;
- указатель на объект события мыши [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### DblClick {#DblClick}

```javascript
DblClick
```

Двойной щелчок левой кнопкой мыши.

В callback-функцию передаются:

- указатель на многоугольник, для которого был вызван обработчик;
- указатель на объект события мыши [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### Drag {#Drag}

```javascript
Drag
```

Продолжается перетаскивание многоугольника.

В callback-функцию передаются два аргумента:

- указатель на многоугольник, для которого был вызван обработчик;
- объект [YMaps.Point](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/point.md) со значением смещения многоугольника в пикселах относительно его предыдущего положения.
### DragEnd {#DragEnd}

```javascript
DragEnd
```

Закончено перетаскивание многоугольника.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### DragStart {#DragStart}

```javascript
DragStart
```

Началось перетаскивание многоугольника (если разрешено).

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### MouseEnter {#MouseEnter}

```javascript
MouseEnter
```

Курсор наведен на многоугольник.

В callback-функцию передаются:

- указатель на многоугольник, для которого был вызван обработчик;
- указатель на объект события мыши [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### MouseLeave {#MouseLeave}

```javascript
MouseLeave
```

Курсор убран с многоугольника.

В callback-функцию передаются:

- указатель на многоугольник, для которого был вызван обработчик;
- указатель на объект события мыши [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### MouseMove {#MouseMove}

```javascript
MouseMove
```

Движение курсора в пределах многоугольника.

В callback-функцию передаются:

- указатель на многоугольник, для которого был вызван обработчик;
- указатель на объект события мыши [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md).
### PositionChange {#PositionChange}

```javascript
PositionChange
```

Изменение координат многоугольника (например, с помощью метода [YMaps.Polygon.addPoint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polygon.md#addPoint)).

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### RemoveFromMap {#RemoveFromMap}

```javascript
RemoveFromMap
```

Удаление многоугольника с карты.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### StartDrawing {#StartDrawing}

```javascript
StartDrawing
```

Включение режима добавления вершин многоугольника.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### StartEditing {#StartEditing}

```javascript
StartEditing
```

Включение режима редактирования многоугольника.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### StopDrawing {#StopDrawing}

```javascript
StopDrawing
```

Отключение режима добавления вершин многоугольника.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
### StopEditing {#StopEditing}

```javascript
StopEditing
```

Отключение режима редактирования многоугольника.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.
## Подробное описание методов {#method_detail}

### AddPoint {#AddPoint}

```javascript
addPoint(point, index)
```

Добавляет одну или несколько вершин в многоугольник. По умолчанию вершины добавляются после вершины с максимальным индексом.

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`point` | [YMaps.ICoordPoint](icoordpoint.md)|[YMaps.ICoordPoint](icoordpoint.md)[] |  |  | Координата вершины или массив координат.
`index` | Integer | ![](../_images/check.png) |  | Позиция, в которую нужно добавить вершину.

### contains {#contains}

```javascript
{Boolean} contains(coordPoint)
```
 Определяет находится ли визуально точка `coordPoint` внутри многоугольника. 	 	 	  	 		
**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`coordPoint` | [YMaps.ICoordPoint](icoordpoint.md) | Точка, для которой определяется принадлежность многоугольнику.


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

Тип | Описание
----- | -----
Boolean | true, если точка внутри многоугольника, иначе false.

### fromEncodedPoints {#fromEncodedPoints}

```javascript
{YMaps.Polygon} fromEncodedPoints(encodedPoints, levels, options, coordSystem)
```

Строит многоугольник из закодированных в Base64 координат его вершин с учетом указанного для каждой вершины уровня видимости.

**См.:** [Ломаная](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/tasks/how-to-add-polyline.md)

**Пример:**

```javascript
// 
map.setCenter(new YMaps.GeoPoint(37.619, 55.753), 1);
var polygon = YMaps.Polygon.fromEncodedPoints(
    "hPD6AgItMQGAaWf_QEtMAAAAAAA8S0wAgGln_0JLTACAlpgAO0tMAAAAAABDS0wAgJaYAEFLTAB3lpgAv7Sz_wAAAAC9tLP_gJaYAMW0s_-AaWf_vrSz_wAAAADEtLP_iWln_8C0s_8=",
    "BCCBCCBCCBCC"
);
map.addOverlay(polygon);
```

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`encodedPoints` | String |  |  | Закодированные в Base64 координаты вершин контуров многоугольника. Кодированные наборы координат вершин для различных контуров многоугольника разделяютя символом ";". Координаты вершин внешнего контура должны передаваться в начале строки.
`levels` | String |  |  | Строка кодов уровней, определяющая для каждой вершины многоугольника значение коэффициента масштабирования, начиная с которого вершина должна отображаться в составе контура соответствующего многоугольника. Наборы уровней для различных контуров многоугольника разделяются символом ";". Если для какой-либо вершины значение уровня не задано, применяется значение по умолчанию "A".
`options` | [YMaps.PolygonOptions](polygonoptions.md) | ![](../_images/check.png) |  | Опции многоугольника.
`coordSystem` | [YMaps.ICoordSystem](icoordsystem.md) | ![](../_images/check.png) | YMaps.GeoCoordSystem | Ссылка на координатную систему.


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

Тип | Описание
----- | -----
[YMaps.Polygon](polygon.md) | Многоугольник.

### getClosestPoint {#getClosestPoint}

```javascript
{Object|null} getClosestPoint(anchorPoint)
```
 Ищет на контуре многоугольника точку, ближайшую к `anchorPoint`. Возвращает объект, содержащий координаты ближайшей точки и индекс начальной вершины стороны многоугольника, на которой лежит найденная точка. Если многоугольник не содержит точек, возвращает null. 	 	 	  	
**Пример:**

```javascript
var polygon = new YMaps.Polygon([
    new YMaps.GeoPoint(0, 0),
    new YMaps.GeoPoint(10, 10),
    new YMaps.GeoPoint(20, 0)
]);

map.addOverlay(polygon);

var closest = polygon.getClosestPoint(
    new YMaps.GeoPoint(15, -5)
);

// closest.point будет содержать экземпляр YMaps.GeoPoint с координатами 0, 15.
// closest.index будет содержать 2.
```

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

Имя | Тип | Описание
----- | ----- | -----
`anchorPoint` | [YMaps.ICoordPoint](icoordpoint.md) | Точка координатной системы, для которой расчитывается ближайшая точка на контуре многоугольника.


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

Тип | Описание
----- | -----
Object|null | Объект с полями `point` (координаты ближайшей точки) и `index` (индекс начальной вершины стороны многоугольника), или null.

### getCoordPath {#getCoordPath}

```javascript
{YMaps.CoordPath} getCoordPath()
```

Возвращает объект, управляющий множеством вершин внешнего контура многоугольника.

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

Тип | Описание
----- | -----
[YMaps.CoordPath](coordpath.md) | Объект множества вершин внешнего контура многоугольника.

### getEditingOptions {#getEditingOptions}

```javascript
{YMaps.PolygonEditingOptions} getEditingOptions()
```

Возвращает опции режима редактирования многоугольника.

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

Тип | Описание
----- | -----
[YMaps.PolygonEditingOptions](polygoneditingoptions.md) | Опции режима редактирования.

### getMap {#getMap}

```javascript
{YMaps.Map} getMap()
```

Возвращает указатель на карту, в которую добавлен многоугольник.

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

Тип | Описание
----- | -----
[YMaps.Map](map.md) | Указатель на карту, в которую добавлен многоугольник.

### getNumPoints {#getNumPoints}

```javascript
{Integer} getNumPoints()
```

Возвращает количество вершин многоугольника.

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

Тип | Описание
----- | -----
Integer | Количество вершин многоугольника.

### getOptions {#getOptions}

```javascript
{YMaps.PolygonOptions} getOptions()
```

Возвращает опции многоугольника.

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

Тип | Описание
----- | -----
[YMaps.PolygonOptions](polygonoptions.md) | Опции многоугольника.

### getPixelPoints {#getPixelPoints}

```javascript
{YMaps.Point[][]} getPixelPoints(options)
```

Возвращает информацию об отображении контуров многоугольника.

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

#|
|| **Имя** | **Тип** | **Описание** ||
||`options` | Object | Объект опций. Может содержать следующие необязательные поля: 
- `zoom``{Integer}` - учитывать только вершины, видимые при указанном в параметре значении коэффициента масштабирования. По умолчанию - при текущем коэффициенте масштабирования.
- `geodesic``{Boolean}` - флаг, указывающий, что в расчет пиксельных координат необходимо включить вершины геодезических кривых. По умолчанию берется значение опции [YMaps.PolygonOptions.geodesic](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/polygonoptions.md#geodesic).||
|#

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

Тип | Описание
----- | -----
[YMaps.Point](point.md)[][] | Массив, каждый элемент которого является массивом пиксельных координат, соответствующих вершинам одного из контуров многоугольника. Первым элементом всегда является массив пиксельных координат внешнего контура многоугольника. Затем следуют массивы пиксельных координат внутренних контуров.

### getPoint {#getPoint}

```javascript
{YMaps.ICoordPoint} getPoint(index)
```

Возвращает вершину многоугольника с заданным индексом.

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

Имя | Тип | Описание
----- | ----- | -----
`index` | Integer | Индекс.


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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Вершину с заданным индексом.

### getPoints {#getPoints}

```javascript
{YMaps.ICoordPoint[]} getPoints()
```

Возвращает координаты вершин многоугольника.

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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md)[] | Координаты вершин многоугольника.

### isDrawing {#isDrawing}

```javascript
{Boolean} isDrawing()
```

Проверяет, находится ли многоугольник в режиме рисования.

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

Тип | Описание
----- | -----
Boolean | true - находится, false - не находится.

### isEditing {#isEditing}

```javascript
{Boolean} isEditing()
```

Проверяет, находится ли многоугольник в режиме редактирования.

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

Тип | Описание
----- | -----
Boolean | true - находится, false - не находится.

### removePoint {#removePoint}

```javascript
{YMaps.ICoordPoint} removePoint(index)
```

Удаляет из многоугольника вершину с заданным индексом.

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

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


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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Координаты удаленной вершины.

### setEditingOptions {#setEditingOptions}

```javascript
setEditingOptions(options)
```

Устанавливает опции режима редактирования многоугольника.

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

Имя | Тип | Описание
----- | ----- | -----
`options` | [YMaps.PolygonEditingOptions](polygoneditingoptions.md) | Опции режима редактирования.

### setOptions {#setOptions}

```javascript
setOptions(options, restoreDefault)
```

Устанавливает опции многоугольника.

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | [YMaps.PolygonOptions](polygonoptions.md) |  |  | Опции многоугольника.
`restoreDefault` | Boolean | ![](../_images/check.png) | false | Незаданные опции установить в значения по умолчанию.

### setPoints {#setPoints}

```javascript
setPoints(points)
```

Устанавливает координаты вершин многоугольника.

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

Имя | Тип | Описание
----- | ----- | -----
`points` | [YMaps.ICoordPoint](icoordpoint.md)[] | Координаты вершин многоугольника.

### splicePoints {#splicePoints}

```javascript
{YMaps.ICoordPoint[]} splicePoints(index, number)
```

Удаляет заданные вершины многоугольника. Если требуется, вставляет на место удаленных другие вершины, которые передаются в метод дополнительными параметрами (после параметра number).

**Примеры:**

**1.**

```javascript
// Удаляет вторую вершину многоугольника.
polygon.splicePoints(1, 1);
```

**2.**

```javascript
// Вставляет новую вершину на вторую позицию.
polygon.splicePoints(1, 0, new YMaps.GeoPoint(37.63, 55.75));
```

**3.**

```javascript
// Заменяет вторую вершину на новую.
polygon.splicePoints(1, 1, new YMaps.GeoPoint(37.63, 55.75));
```

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

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


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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md)[] | Координаты удаленных вершин.

### startEditing {#startEditing}

```javascript
startEditing()
```

Включает режим редактирования многоугольника. Должен вызываться после добавления многоугольника на карту.
### stopEditing {#stopEditing}

```javascript
stopEditing()
```

Отключает режим редактирования многоугольника.
