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

# YMaps.ICoordBounds

Интерфейс объекта, представляющего собой прямоугольную область на карте. Этот интерфейс требуется реализовывать при создании пользовательской координатной системы. Примером такой реализации является [YMaps.GeoBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/geobounds.md).
## Конструктор

Имя | Описание
----- | -----
[YMaps.ICoordBounds](icoordbounds.md#constructor)(leftBottom, rightTop) | Интерфейс объекта, представляющего собой прямоугольную область на карте.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[contains](icoordbounds.md#contains)(coordPoint) | Boolean | Возвращает true, если переданная точка попадает в область, false - если не попадает.
[copy](icoordbounds.md#copy)() | [YMaps.ICoordBounds](icoordbounds.md) | Возвращает копию объекта.
[equals](icoordbounds.md#equals)(coordBounds) | Boolean | Сравнивает два объекта, представляющих области на карте.
[getBottom](icoordbounds.md#getBottom)() | Number | Возвращает нижнюю границу области.
[getCenter](icoordbounds.md#getCenter)() | [YMaps.ICoordPoint](icoordpoint.md) | Возвращает центр области в виде точки координатной системы.
[getLeft](icoordbounds.md#getLeft)() | Number | Возвращает левую границу области.
[getLeftBottom](icoordbounds.md#getLeftBottom)() | [YMaps.ICoordPoint](icoordpoint.md) | Возвращает левый нижний угол области в виде точки координатной системы.
[getLeftTop](icoordbounds.md#getLeftTop)() | [YMaps.ICoordPoint](icoordpoint.md) | Возвращает левый верхний угол области в виде точки координатной системы.
[getMapZoom](icoordbounds.md#getMapZoom)(map) | Number | Возвращает коэффициент масштабирования, при котором данная прямоугольная область будет видна на карте целиком.
[getRight](icoordbounds.md#getRight)() | Number | Возвращает правую границу области.
[getRightBottom](icoordbounds.md#getRightBottom)() | [YMaps.ICoordPoint](icoordpoint.md) | Возвращает правый нижний угол области в виде точки координатной системы.
[getRightTop](icoordbounds.md#getRightTop)() | [YMaps.ICoordPoint](icoordpoint.md) | Возвращает правый верхний угол области в виде точки координатной системы.
[getSpan](icoordbounds.md#getSpan)() | [YMaps.Size](size.md) | Возвращает линейные размеры области в виде объекта [YMaps.Size](size.md).
[getTop](icoordbounds.md#getTop)() | Number | Возвращает верхнюю границу области.


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

```javascript
YMaps.ICoordBounds(leftBottom, rightTop)
```

Интерфейс объекта, представляющего собой прямоугольную область на карте.

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

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

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

### contains {#contains}

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

Возвращает true, если переданная точка попадает в область, false - если не попадает.

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

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


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

Тип | Описание
----- | -----
Boolean | true - попадает в область, false - не попадает.

### copy {#copy}

```javascript
{YMaps.ICoordBounds} copy()
```

Возвращает копию объекта.

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

Тип | Описание
----- | -----
[YMaps.ICoordBounds](icoordbounds.md) | Копию объекта.

### equals {#equals}

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

Сравнивает два объекта, представляющих области на карте. Сравнивается текущая область и область заданная параметром coordBounds. Функция возвращает true, если объекты представляют идентичные области.

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

Имя | Тип | Описание
----- | ----- | -----
`coordBounds` | [YMaps.ICoordBounds](icoordbounds.md) | Область на карте.


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

Тип | Описание
----- | -----
Boolean | true - области совпадают, false - области не совпадают.

### getBottom {#getBottom}

```javascript
{Number} getBottom()
```

Возвращает нижнюю границу области.

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

Тип | Описание
----- | -----
Number | Нижнюю границу области.

### getCenter {#getCenter}

```javascript
{YMaps.ICoordPoint} getCenter()
```

Возвращает центр области в виде точки координатной системы.

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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Центр области.

### getLeft {#getLeft}

```javascript
{Number} getLeft()
```

Возвращает левую границу области.

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

Тип | Описание
----- | -----
Number | Левую границу области.

### getLeftBottom {#getLeftBottom}

```javascript
{YMaps.ICoordPoint} getLeftBottom()
```

Возвращает левый нижний угол области в виде точки координатной системы.

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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Левый нижний угол области.

### getLeftTop {#getLeftTop}

```javascript
{YMaps.ICoordPoint} getLeftTop()
```

Возвращает левый верхний угол области в виде точки координатной системы.

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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Левый верхний угол области.

### getMapZoom {#getMapZoom}

```javascript
{Number} getMapZoom(map)
```

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

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

Имя | Тип | Описание
----- | ----- | -----
`map` | [YMaps.Map](map.md) | Карта, для которой требуется вычислить коэффициент масштабирования.


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

Тип | Описание
----- | -----
Number | Коэффициент масштабирования.

### getRight {#getRight}

```javascript
{Number} getRight()
```

Возвращает правую границу области.

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

Тип | Описание
----- | -----
Number | Правую границу области.

### getRightBottom {#getRightBottom}

```javascript
{YMaps.ICoordPoint} getRightBottom()
```

Возвращает правый нижний угол области в виде точки координатной системы.

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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Правый нижний угол области.

### getRightTop {#getRightTop}

```javascript
{YMaps.ICoordPoint} getRightTop()
```

Возвращает правый верхний угол области в виде точки координатной системы.

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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Правый верхний угол области.

### getSpan {#getSpan}

```javascript
{YMaps.Size} getSpan()
```

Возвращает линейные размеры области в виде объекта [YMaps.Size](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/size.md).

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

Тип | Описание
----- | -----
[YMaps.Size](size.md) | Размеры области.

### getTop {#getTop}

```javascript
{Number} getTop()
```

Возвращает верхнюю границу области.

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

Тип | Описание
----- | -----
Number | Верхнюю границу области.