---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/llms.txt

# ICircleGeometryAccess

Расширяет [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md).

Интерфейс доступа к геометрии "Круг".

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

```javascript
ICircleGeometryAccess()
```

## Поля {#fields}

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

Унаследовано от [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#events). ||
|#

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

#|
|| **Имя** | **Описание** ||
|| [change](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#change) | Изменение координат. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get:

• oldCoordinates - старые координаты центра;

• newCoordinates - новые координаты центра;

• oldRadius - старый радиус;

• newRadius - новый радиус. ||
|#

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [contains](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#contains)([position](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#contains-param-position)) | Boolean | Проверяет, лежит ли переданная точка внутри круга. ||
|| [freeze](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#freeze)() | [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md) | Переводит объект в "замороженный" режим.

Унаследован от [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#freeze). ||
|| [getClosest](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#getClosest)([anchorPosition](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#getClosest-param-anchorPosition)) | Object | Ищет на окружности точку, ближайшую к anchorPosition. ||
|| [getCoordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#getCoordinates)() | Number[]\|null | Returns координаты центра круга. ||
|| [getRadius](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#getRadius)() | Number | Returns радиус круга. ||
|| [isFrozen](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#isFrozen)() | Boolean | Returns true, если объект находится в "замороженном" режиме, иначе false.

Унаследован от [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#isFrozen). ||
|| [setCoordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#setCoordinates)([coordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#setCoordinates-param-coordinates)) | [ICircleGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md) | Задает координаты центра круга. ||
|| [setRadius](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#setRadius)([radius](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#setRadius-param-radius)) | [ICircleGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md) | Задает радиус круга. ||
|| [unfreeze](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md#unfreeze)() | [IFreezable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IFreezable.md) | Переводит объект в активный режим.

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

## Описание событий {#description-events}

### change

Изменение координат. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get:

• oldCoordinates - старые координаты центра;

• newCoordinates - новые координаты центра;

• oldRadius - старый радиус;

• newRadius - новый радиус.

## Описание методов {#description-methods}

### contains

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

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

**Returns** признак принадлежности точки кругу.

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

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

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

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

**Пример:**

```javascript
var myCircle = new ymaps.geometry.base.Circle([0, 0], 10);
myCircle.contains([0, 10]); // => true
```

### getClosest

```javascript
{Object} getClosest(anchorPosition)
```

Ищет на окружности точку, ближайшую к anchorPosition.

**Returns** объект со следующими полями:

• position - точка на окружности, ближайшая к anchorPosition;

• distance - расстояние от anchorPosition до position;

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

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

Координаты точки, для которой расчитывается ближайшая точка на окружности. ||
|#

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

**Пример:**

```javascript
var myCircle = new ymaps.geometry.base.Circle([0, 0], 10);
myCircle.getClosest([0, 15]).position; // => [0, 10]
```

### getCoordinates

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

**Returns** координаты центра круга.

### getRadius

```javascript
{Number} getRadius()
```

**Returns** радиус круга.

### setCoordinates

```javascript
{ICircleGeometryAccess} setCoordinates(coordinates)
```

Задает координаты центра круга.

**Returns** ссылку на себя.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `coordinates`[*](*parametr) | — | Тип: Number[]/null

Координаты центра круга. ||
|#

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

### setRadius

```javascript
{ICircleGeometryAccess} setRadius(radius)
```

Задает радиус круга.

**Returns** ссылку на себя.

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

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

Радиус круга. ||
|#

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

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