---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.2
alternate:
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geometry.Circle.md
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometry.Circle.md
  - href: https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geometry.Circle.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.com.tr/dev/jsapi-v2-1/doc/en/llms.txt?revision=r21950234
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/en/llms.txt?revision=r21950234

# geometry.Circle

Extends [ICircleGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometry.md).

The "Circle" geometry.

**See** [Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Circle.md)

[Constructor](#constructor-summary) | [Fields](#properties-summary) | [Events](#events-summary) | [Methods](#methods-summary)

## Constructor {#constructor-summary}

```javascript
geometry.Circle([coordinates[, radius[, options]]])
```

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`coordinates`](#param-coordinates) | null | Type: Number[]\|null

Coordinates of the center of the circle. ||
|| [`radius`](#param-radius) | 0 | Type: Number

Radius of the circle in meters. ||
|| [`options`](#param-options) | — | Type: Object

Geometry options. ||
|| [`options.geodesic`](#param-options.geodesic) | false | Type: Boolean

Enables display using geodesic lines. ||
|| [`options.pixelRendering`](#param-options.pixelRendering) | "jumpy" | Type: String

Method for calculating pixel coordinates of the shape in cycled projections. This option accepts one of the following values: 
- jumpy - The shape is placed as close as possible to the center of the map viewport, and can "jump" 	when the map is being moved.
- static - The shape is always located in the initial world and does not move when the map is moved. ||
|| [`options.projection`](#param-options.projection) | — | Type: [IProjection](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IProjection.md)

Projection. ||
|#


**Example:**

```javascript
// Creating an instance of the circle geometry class (specifying the coordinates and radius in meters).
var circleGeometry = new ymaps.geometry.Circle([30, 50], 10);
// Creating an instance of the geo object class and passing our geometry to the constructor.
var circleGeoObject = new ymaps.GeoObject({ geometry: circleGeometry });

// Changing the geometry's radius via the geo object's "geometry" property.
circleGeoObject.geometry.setRadius(5)
// Or directly.
circleGeometry.setRadius(5);
// You can also access circleGeometry via circleGeoObject.geometry.
```

## Fields {#properties-summary}

#|
|| **Name** | **Type** | **Description** ||
|| [events](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventManager.md)| Event manager.

Inherited from [IEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events). ||
|| [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOptionManager.md)| Options manager.

Inherited from [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#options). ||
|#

## Events {#events-summary}

#|
|| **Name** | **Description** ||
|| [change](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#event-change)| Changed coordinates. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: 
- oldCoordinates - Old coordinates of the center.
- newCoordinates - New coordinates of the center.
- oldRadius - Old radius.
- newRadius - New radius.

Inherited from [ICircleGeometryAccess](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#event-change). ||
|| [mapchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#event-mapchange)| Map reference changed. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: 
- oldMap - Old map.
- newMap - New map.

Inherited from [IGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#event-mapchange). ||
|| [optionschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#event-optionschange)| Change to the object options.

Inherited from [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#event-optionschange). ||
|| [pixelgeometrychange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#event-pixelgeometrychange)| The pixel geometry changed. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: 
- pixelGeometry - New [IPixelGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md) pixel geometry.

Inherited from [IGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#event-pixelgeometrychange). ||
|#

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [contains](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#contains)([position](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#contains-param-position)) | Boolean
| Checks whether the passed point is located inside the circle.

Inherited from [ICircleGeometryAccess](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#contains). ||
|| [freeze](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IFreezable.md#freeze)() | [IFreezable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IFreezable.md)
| Switches the object to "frozen" mode.

Inherited from [IFreezable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IFreezable.md#freeze). ||
|| [getBounds](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#getBounds)() | Number[][]\|null
| Returns coordinates of the two opposite corners of the area that surrounds the geometry. The first item in the array is the southwest corner of the area; the second item is the northeast corner.

Inherited from [IGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#getBounds). ||
|| [getClosest](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#getClosest)([anchorPosition](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#getClosest-param-anchorPosition)) | Object
| Searches for a point on the circle closest to the anchorPosition.

Inherited from [ICircleGeometryAccess](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#getClosest). ||
|| [getCoordinates](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#getCoordinates)() | Number[]\|null
| Returns coordinates of the center of the circle.

Inherited from [ICircleGeometryAccess](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#getCoordinates). ||
|| [getMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#getMap)() | [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Map.md)\|null
| Returns the current map.

Inherited from [IGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#getMap). ||
|| [getPixelGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#getPixelGeometry)([[options](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#getPixelGeometry-param-options)]) | [IPixelGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelGeometry.md)
| Returns the pixel geometry corresponding to the given geometry, its options, and the map state.

Inherited from [IGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#getPixelGeometry). ||
|| [getRadius](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#getRadius)() | Number
| Returns radius of the circle.

Inherited from [ICircleGeometryAccess](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#getRadius). ||
|| [getType](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometry.md#getType)() | String
| Returns the "Circle" string.

Inherited from [ICircleGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometry.md#getType). ||
|| [isFrozen](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IFreezable.md#isFrozen)() | Boolean
| Returns true if the object is in "frozen" mode, otherwise false.

Inherited from [IFreezable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IFreezable.md#isFrozen). ||
|| [setCoordinates](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#setCoordinates)([coordinates](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#setCoordinates-param-coordinates)) | [ICircleGeometryAccess](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md)
| Sets the coordinates of the center of the circle.

Inherited from [ICircleGeometryAccess](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#setCoordinates). ||
|| [setMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#setMap)([map](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#setMap-param-map)) | | Sets the map.

Inherited from [IGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md#setMap). ||
|| [setRadius](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#setRadius)([radius](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#setRadius-param-radius)) | [ICircleGeometryAccess](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md)
| Sets the radius of the circle.

Inherited from [ICircleGeometryAccess](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometryAccess.md#setRadius). ||
|| [unfreeze](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IFreezable.md#unfreeze)() | [IFreezable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IFreezable.md)
| Switches the object to active mode.

Inherited from [IFreezable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IFreezable.md#unfreeze). ||
|#