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

# ICircleGeometryAccess

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

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

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

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

```javascript
ICircleGeometryAccess()
```

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

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

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

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

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


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

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

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

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

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

## Описание событий {#event_detail}

### change {#change}

Изменение координат. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- oldCoordinates - старые координаты центра;
- newCoordinates - новые координаты центра;
- oldRadius - старый радиус;
- newRadius - новый радиус.

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

### contains {#contains}

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

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

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

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

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

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

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

**Пример:**

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

### getClosest {#getClosest}

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

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

**Возвращает** объект со следующими полями:
- position - точка на окружности, ближайшая к anchorPosition;
- distance - расстояние от anchorPosition до position;

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

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

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

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

**Пример:**

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

### getCoordinates {#getCoordinates}

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

**Возвращает** координаты центра круга.

### getRadius {#getRadius}

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

**Возвращает** радиус круга.

### setCoordinates {#setCoordinates}

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

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

**Возвращает** ссылку на себя.

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

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

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

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

### setRadius {#setRadius}

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

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

**Возвращает** ссылку на себя.

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

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

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

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

<!-- XLIFF_FARM_MTQ1MmQ5_CACHING -->

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