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

# IShape

Интерфейс фигуры. Фигура представляет совокупность пиксельной геометрии, а также математических и логических параметров ее отображения (таких как наличие контура и его ширина, наличие заливки).

[Конструктор](#constructor-summary) | [Методы ](#methods-summary)

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

```javascript
IShape()
```

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [contains](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#contains)([position](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#contains-param-position)) | Boolean | Проверяет лежит ли переданная точка внутри фигуры. ||
|| [equals](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#equals)([shape](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#equals-param-shape)) | Boolean | Возвращает true, если переданная фигура эквивалентна данной. ||
|| [getBounds](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#getBounds)() | Number[][]\|null | Возвращает координаты двух противоположных углов области, охватывающей фигуру. Первый элемент массива - угол с наименьшими значениями координат относительно остальных точек области; второй элемент - угол с наибольшими значениями координат. ||
|| [getGeometry](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#getGeometry)() | [IPixelGeometry](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPixelGeometry.md) | Возвращает пиксельную геометрию фигуры. ||
|| [getType](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#getType)() | String | Возвращает идентификатор типа геометрии. ||
|| [scale](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#scale)([factor](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#scale-param-factor)) | [IShape](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md) | Создает отмасштабированную копию фигуры. ||
|| [shift](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#shift)([offset](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md#shift-param-offset)) | [IShape](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md) | Создает копию фигуры сдвинутую на заданную величину. ||
|#

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

### contains {#contains}

```javascript
{Boolean} contains(position)
```

Проверяет лежит ли переданная точка внутри фигуры.

**Возвращает** true, если переданная точка лежит внутри фигуры.

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

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

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

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

### equals {#equals}

```javascript
{Boolean} equals(shape)
```

**Возвращает** true, если переданная фигура эквивалентна данной.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`shape`](#equals-param-shape)[*](*star) | — | Тип: [IShape](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md)

Фигура, с которой производится сравнение. ||
|#

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

### getBounds {#getBounds}

```javascript
{Number[][]|null} getBounds()
```

**Возвращает** координаты двух противоположных углов области, охватывающей фигуру. Первый элемент массива - угол с наименьшими значениями координат относительно остальных точек области; второй элемент - угол с наибольшими значениями координат.

### getGeometry {#getGeometry}

```javascript
{IPixelGeometry} getGeometry()
```

**Возвращает** пиксельную геометрию фигуры.

### getType {#getType}

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

**Возвращает** идентификатор типа геометрии.

### scale {#scale}

```javascript
{IShape} scale(factor)
```

Создает отмасштабированную копию фигуры.

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

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

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

Масштабный коэффициент. ||
|#

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

### shift {#shift}

```javascript
{IShape} shift(offset)
```

Создает копию фигуры сдвинутую на заданную величину.

**Возвращает** сдвинутую копию фигуры.

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

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

Величина сдвига по осям. ||
|#

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

<!-- XLIFF_FARM_YmEzMTg2_CACHING -->

[*star]: Обязательный параметр.