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

# YMaps.ICoordSystem

Интерфейс системы координат. Этот интерфейс требуется реализовывать при создании пользовательской координатной системы.
## Конструктор

Имя | Описание
----- | -----
[YMaps.ICoordSystem](icoordsystem.md#constructor)() | Интерфейс системы координат.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[distance](icoordsystem.md#distance)(coordPoint1, coordPoint2) | Number | Возвращает кратчайшее расстояние (по геодезической) между двумя точками координатной системы.
[fromCoordPoint](icoordsystem.md#fromCoordPoint)(point, anchor) | [YMaps.Point](point.md) | Преобразует координаты точки, заданные в пользовательской координатной системе в пиксельные координаты.
[getCoordBounds](icoordsystem.md#getCoordBounds)(leftBottom, rightTop) | [YMaps.ICoordBounds](icoordbounds.md) | Возвращает объект, соответствующий области на карте, заданной двумя точками системы координат.
[getCoordPoint](icoordsystem.md#getCoordPoint)(x, y, unbounded) | [YMaps.ICoordPoint](icoordpoint.md) | Возвращает объект, соответствующий точке {x,y} в координатной системе.
[getMaxZoom](icoordsystem.md#getMaxZoom)() | Integer | Возвращает максимальный коэффициент масштабирования.
[getWorldSize](icoordsystem.md#getWorldSize)() | [YMaps.Size](size.md) | Возвращает размеры мира (в пикселах) при максимальном масштабе в виде объекта [YMaps.Size](size.md).
[restrict](icoordsystem.md#restrict)(coordPoint) | [YMaps.ICoordPoint](icoordpoint.md) | Позволяет ограничить область отображения географических объектов на карте. Например, не отображать околополярные (с широтой выше 89.3 градусов) области в проекции Меркатора.
[rulerDistance](icoordsystem.md#rulerDistance)(coordPoint1, coordPoint2) | Number | Возвращает расстояние "по линейке" между двумя точками координатной системы.
[toCoordPoint](icoordsystem.md#toCoordPoint)(pixelPoint, unbounded) | [YMaps.ICoordPoint](icoordpoint.md) | Преобразует пиксельные координаты точки в координаты, заданные в пользовательской координатной системе.


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

```javascript
YMaps.ICoordSystem()
```

Интерфейс системы координат.
## Подробное описание методов {#method_detail}

### distance {#distance}

```javascript
{Number} distance(coordPoint1, coordPoint2)
```

Возвращает кратчайшее расстояние (по геодезической) между двумя точками координатной системы.

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

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


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

Тип | Описание
----- | -----
Number | Расстояние по геодезической прямой.

### fromCoordPoint {#fromCoordPoint}

```javascript
{YMaps.Point} fromCoordPoint(point, anchor)
```

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

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

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


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

Тип | Описание
----- | -----
[YMaps.Point](point.md) | Точку в пиксельных координатах.

### getCoordBounds {#getCoordBounds}

```javascript
{YMaps.ICoordBounds} getCoordBounds(leftBottom, rightTop)
```

Возвращает объект, соответствующий области на карте, заданной двумя точками системы координат.

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

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


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

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

### getCoordPoint {#getCoordPoint}

```javascript
{YMaps.ICoordPoint} getCoordPoint(x, y, unbounded)
```

Возвращает объект, соответствующий точке {x,y} в координатной системе.

**См.:** [Преобразование координат](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/concepts/coordinates_conversion.md)

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

#|
|| **Имя** | **Тип** | **Необязательный** | **По умолчанию** | **Описание** ||
|| `x` | Number |  |  | Первая координата.||
||`y` | Number |  |  | Вторая координата.||
||`unbounded` | Boolean | ![](../_images/check.png) | false | Флаг, указывающий тип возвращаемой точки. Требуется для координатных систем, в которых точка может изменять свое положение на карте в зависимости от положения обозревателя (например, в системах, "склеенных" в кольцо по одной из координат).

Для геоточек в географической системе координат true обозначает неограниченную точку, false - ограниченную.||
|#


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

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Объект-точку.

### getMaxZoom {#getMaxZoom}

```javascript
{Integer} getMaxZoom()
```

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

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

Тип | Описание
----- | -----
Integer | Максимальный коэффициент масштабирования.

### getWorldSize {#getWorldSize}

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

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

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

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

### restrict {#restrict}

```javascript
{YMaps.ICoordPoint} restrict(coordPoint)
```

Позволяет ограничить область отображения географических объектов на карте. Например, не отображать околополярные (с широтой выше 89.3 градусов) области в проекции Меркатора. Если точка попадает в неотображаемую область карты, то метод вернет координаты ближайшей точки, которую возможно отобразить.

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

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


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

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

### rulerDistance {#rulerDistance}

```javascript
{Number} rulerDistance(coordPoint1, coordPoint2)
```

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

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

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


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

Тип | Описание
----- | -----
Number | Расстояние "по линейке".

### toCoordPoint {#toCoordPoint}

```javascript
{YMaps.ICoordPoint} toCoordPoint(pixelPoint, unbounded)
```

Преобразует пиксельные координаты точки в координаты, заданные в пользовательской координатной системе. Пиксельные координаты должны быть рассчитаны при максимальном масштабе карты.

**См.:** [Преобразование координат](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/concepts/coordinates_conversion.md)

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

#|
|| **Имя** | **Тип** | **Необязательный** | **По умолчанию** | **Описание** ||
||`pixelPoint` | [YMaps.Point](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/point.md) |  |  | Пиксельные координаты точки при максимальном масштабе карты.||
||`unbounded` | Boolean | ![](../_images/check.png) | false | Флаг, указывающий тип возвращаемой точки. Требуется для координатных систем, в которых точка может изменять свое положение на карте в зависимости от положения обозревателя (например, в системах, "склеенных" в кольцо по одной из координат).

Для геоточек в географической системе координат true обозначает неограниченную точку, false - ограниченную.||
|#


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

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

