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

# IBasePolygonGeometry

Расширяет [IBaseGeometry](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBaseGeometry.md), [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md).

Интерфейс геометрии "Многоугольник".

[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

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

```javascript
IBasePolygonGeometry()
```

## Поля {#properties-summary}

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

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

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

#|
|| **Имя** | **Описание** ||
|| [change](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#event-change) | Изменение координат. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- oldCoordinates — старые координаты;
- newCoordinates - новые координаты;
- oldFillRule - старый алгоритм заливки;
- newFillRule - новые алгоритм заливки.

Унаследовано от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#event-change). ||
|#


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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [contains](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#contains)([position](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#contains-param-position)) | Boolean | Проверяет, лежит ли переданная точка внутри многоугольника.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#contains). ||
|| [freeze](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IFreezable.md#freeze)() | [IFreezable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IFreezable.md) | Переводит объект в "замороженный" режим.

Унаследован от [IFreezable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IFreezable.md#freeze). ||
|| [get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#get)([index](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#get-param-index)) | Number[][] | Возвращает координаты контура c заданным индексом.

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

Унаследован от [IBaseGeometry](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBaseGeometry.md#getBounds). ||
|| [getChildGeometry](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getChildGeometry)([index](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getChildGeometry-param-index)) | [ILinearRingGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ILinearRingGeometryAccess.md) | Создает и возвращает объект [ILinearRingGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ILinearRingGeometryAccess.md) для заданного контура.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getChildGeometry). ||
|| [getClosest](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getClosest)([anchorPosition](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getClosest-param-anchorPosition)) | Object | Ищет на контуре многоугольника точку, ближайшую к anchorPosition.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getClosest). ||
|| [getCoordinates](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getCoordinates)() | Number[][][] | Возвращает массив координат геометрии.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getCoordinates). ||
|| [getFillRule](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getFillRule)() | String | Возвращает идентификатор алгоритма заливки.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getFillRule). ||
|| [getLength](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getLength)() | Integer | Возвращает количество контуров в геометрии.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#getLength). ||
|| [getType](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBasePolygonGeometry.md#getType)() | String | Возвращает строку "Polygon". ||
|| [insert](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#insert)([index](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#insert-param-index), [path](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#insert-param-path)) | [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md) | Добавляет новый контур с заданным индексом.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#insert). ||
|| [isFrozen](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IFreezable.md#isFrozen)() | Boolean | Возвращает true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от [IFreezable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IFreezable.md#isFrozen). ||
|| [remove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#remove)([index](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#remove-param-index)) | [ILinearRingGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ILinearRingGeometryAccess.md) | Удаляет контур с заданным индексом.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#remove). ||
|| [set](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#set)([index](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#set-param-index), [path](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#set-param-path)) | [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md) | Задает координаты контура c заданным индексом.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#set). ||
|| [setCoordinates](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#setCoordinates)([coordinates](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#setCoordinates-param-coordinates)) | [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md) | Задает массив координат геометрии.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#setCoordinates). ||
|| [setFillRule](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#setFillRule)([fillRule](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#setFillRule-param-fillRule)) | [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md) | Задает алгоритм заливки многоугольника.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#setFillRule). ||
|| [splice](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#splice)([index](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#splice-param-index), [number](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#splice-param-number)) | [ILinearRingGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ILinearRingGeometryAccess.md)[] | Удаляет определенное число контуров начиная с заданного индекса. При этом на место удаляемых контуров могут быть добавлены новые. Координаты новых контуров можно передавать дополнительными аргументами после параметра number.

Унаследован от [IPolygonGeometryAccess](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPolygonGeometryAccess.md#splice). ||
|| [unfreeze](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IFreezable.md#unfreeze)() | [IFreezable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IFreezable.md) | Переводит объект в активный режим.

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

## Описание методов {#method_detail}

### getType {#getType}

```javascript
{String} getType()
```

**Возвращает** строку "Polygon".

<!-- XLIFF_FARM_MzkxZmQ2_CACHING -->