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

# Circle

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

Circle. A geo object with the geometry [geometry.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geometry.Circle.md).

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

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

## Constructor {#constructor-summary}

```javascript
Circle(geometry[, properties[, options]])
```

Creates an instance of a circle.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`geometry`](#param-geometry)[*](*star) | — | Type: [ICircleGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICircleGeometry.md)\|Number[][]\|Object

Reference to a point geometry object or an array, in which the first item is the coordinates of the center of the circle, and the second is the radius in meters, or an object with the parameters of the geometry. ||
|| [`properties`](#param-properties) | — | Type: Object\|[IDataManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDataManager.md)

Circle data. Corresponds to the data for the [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md) object. Can be set as an instance of a class that implements the [IDataManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDataManager.md) interface, or as a hash. When options are set to default values, the following data fields are interpreted by a circle: 
- hintContent - Content of the circle's popup hint.
- balloonContent - Content of the circle's balloon.
- balloonContentHeader - Content of the circle balloon title.
- balloonContentBody - Content of the main part of the circle's balloon.
- balloonContentFooter - Content of the lower part of the circle's balloon.
The balloonContent field is a shortcut for the balloonContentBody field, but if they are both set simultaneously, balloonContentBody takes priority. You can also add your own custom fields to the circle data and use them wherever possible. For example, in the circle layout or balloon layout. ||
|| [`options`](#param-options) | — | Type: Object

Circle options. Using this parameter, you can set options for the circle itself, as well as for its parts: 
- Options for the circle's [balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Balloon.md#constructor-summary) with the `balloon` prefix.
- Options for the circle's [popup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Hint.md#constructor-summary) hint with the `hint` prefix.
- Options for the circle's geometry editor with the `editor` prefix. See the description of the [geometryEditor.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geometryEditor.Circle.md) class.
- Geometry options can be set without a prefix. See the description of the [IGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md) class for the [geometry.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geometry.Circle.md) geometry. ||
|| [`options.circleOverlay`](#param-options.circleOverlay) | "default#circle" | Type: String\|Function

Key identifier from [overlay.storage](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.storage.md) or the overlay class. The generator function accepts three parameters: 
- geometry: [IPixelCircleGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPixelCircleGeometry.md) - The pixel geometry itself.
- data: Object - The overlay data.
- options: Object - The overlay options.
And returns [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md). ||
|| [`options.cursor`](#param-options.cursor) | "pointer" | Type: String

Type of cursor over a circle. ||
|| [`options.draggable`](#param-options.draggable) | false | Type: Boolean

Checks whether the circle can be dragged. ||
|| [`options.fill`](#param-options.fill) | true | Type: Boolean

Whether the shape is filled. ||
|| [`options.fillColor`](#param-options.fillColor) | "0066ff99" | Type: String

Fill color. ||
|| [`options.fillImageHref`](#param-options.fillImageHref) | — | Type: String

Background image. When this option is enabled in **stretch** mode, the "fillColor" value is ignored. ||
|| [`options.fillMethod`](#param-options.fillMethod) | 'stretch' | Type: String

Type of background fill. Accepts one of two values: 
- stretch - The background image stretches to fit the size of the overlay.
- tile - The background image is repeated, without changing its size. This is similar to background-repeat in CSS. It can be used for filling a shape with a template. ||
|| [`options.fillOpacity`](#param-options.fillOpacity) | 1 | Type: Number

Fill transparency. ||
|| [`options.hasBalloon`](#param-options.hasBalloon) | true | Type: Boolean

Checks whether the circle has the "balloon" field. ||
|| [`options.hasHint`](#param-options.hasHint) | true | Type: Boolean

Checks whether the circle has the "hint" field. ||
|| [`options.hideIconOnBalloonOpen`](#param-options.hideIconOnBalloonOpen) | true | Type: Boolean

Hide the icon when opening the balloon. ||
|| [`options.interactiveZIndex`](#param-options.interactiveZIndex) | false | Type: Boolean

Enables automatically modifying the z-index of the circle depending on its state. ||
|| [`options.interactivityModel`](#param-options.interactivityModel) | "default#geoObject" | Type: String

Interactivity model. Available keys and their values are listed in the description of [interactivityModel.storage](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/interactivityModel.storage.md). ||
|| [`options.opacity`](#param-options.opacity) | 1 | Type: Number

Transparency. ||
|| [`options.openBalloonOnClick`](#param-options.openBalloonOnClick) | true | Type: Boolean

Checks whether to show the balloon when the circle is clicked on. ||
|| [`options.openEmptyBalloon`](#param-options.openEmptyBalloon) | false | Type: Boolean

Checks whether to show an empty balloon when the circle is clicked on. ||
|| [`options.openEmptyHint`](#param-options.openEmptyHint) | false | Type: Boolean

Checks whether to show an empty hint when the mouse pointer hovers over the circle. ||
|| [`options.openHintOnHover`](#param-options.openHintOnHover) | true | Type: Boolean

Checks whether to show the hint when the mouse pointer hovers over the circle. ||
|| [`options.outline`](#param-options.outline) | true | Type: Boolean

Whether the circle has an outline. ||
|| [`options.pane`](#param-options.pane) | "areas" | Type: String

The key of the pane where the circle overlay is placed. ||
|| [`options.strokeColor`](#param-options.strokeColor) | "0066ffff" | Type: String\|String[]

Color of the line or outline. You can set multiple values for a multistroke outline. ||
|| [`options.strokeOpacity`](#param-options.strokeOpacity) | 1 | Type: Number\|Number[]

Transparency of the line or outline. You can set multiple values for a multistroke outline. ||
|| [`options.strokeStyle`](#param-options.strokeStyle) | — | Type: String\|Object\|String\[]\|Object[]

Style of the line or outline. Available styles are listed in the [graphics.style.stroke](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/graphics.style.stroke.md) object. ||
|| [`options.strokeWidth`](#param-options.strokeWidth) | 1 | Type: Number\|Number[]

Thickness of the line or outline. You can set multiple values for a multistroke outline. ||
|| [`options.syncOverlayInit`](#param-options.syncOverlayInit) | false | Type: Boolean

Enables synchronously adding an overlay to the map. By default, overlays are added to the map asynchronously to prevent the browser from hanging when adding a large number of geo objects. However, adding asynchronously does not allow accessing the overlay immediately after adding a circle to the map. ||
|| [`options.useMapMarginInDragging`](#param-options.useMapMarginInDragging) | true | Type: Boolean

When an object is dragged to the edge of the map, the map center changes automatically. Whether to use map margins when automatically shifting the map center with [map.margin.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.margin.Manager.md). ||
|| [`options.visible`](#param-options.visible) | true | Type: Boolean

Checks circle visibility. ||
|| [`options.zIndex`](#param-options.zIndex) | — | Type: Number

The z-index of a circle in its normal state. Lowest priority. ||
|| [`options.zIndexActive`](#param-options.zIndexActive) | — | Type: Number

The z-index of a circle with an open balloon. Highest priority. ||
|| [`options.zIndexDrag`](#param-options.zIndexDrag) | — | Type: Number

The z-index of a circle that is being dragged. ||
|| [`options.zIndexHover`](#param-options.zIndexHover) | — | Type: Number

The z-index of a circle when the mouse pointer is hovering over it. ||
|#

\* Mandatory parameter/option.

**Example:**

```javascript
// Creating a geodesic circle with a radius of 1000 kilometers.
var circle = new ymaps.Circle([[50, 75], 1000000], {}, {
    geodesic: true
});
// Adding the circle to the map.
myMap.geoObjects.add(circle);
```

## Fields {#properties-summary}

#|
|| **Name** | **Type** | **Description** ||
|| [balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#balloon) | [geoObject.Balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Balloon.md)| Balloon for a geo object.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#balloon). ||
|| [editor](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Circle.md#editor) | [geometryEditor.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geometryEditor.Circle.md)| The "Circle" geometry editor. ||
|| [events](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#events) | [event.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/event.Manager.md)| Event manager.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#events). ||
|| [geometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Circle.md#geometry) | [geometry.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geometry.Circle.md)| The "Circle" type of geometry. ||
|| [hint](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#hint) | [geoObject.Hint](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Hint.md)| Geo object hint.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#hint). ||
|| [indices](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Circle.md#indices) | ArrayBuffer | ||
|| [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#options) | [option.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/option.Manager.md)| Geo object options manager.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#options). ||
|| [properties](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#properties) | [data.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/data.Manager.md)| Geo object data manager.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#properties). ||
|| [state](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#state) | [data.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/data.Manager.md)| State of the geo object. Defined by the following fields: 
- active: Boolean - Indicates that a balloon is open on the geo object.
- hover: Boolean - Indicates that the mouse is currently pointed at the geo object.
- drag: Boolean - Indicates that the geo object is being dragged

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#state). ||
|| [vertices](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Circle.md#vertices) | ArrayBuffer | ||
|#

## Events {#events-summary}

#|
|| **Name** | **Description** ||
|| [balloonclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-balloonclose)| Closing the balloon. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-balloonclose). ||
|| [balloonopen](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-balloonopen)| Opening a balloon on a geo object. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-balloonopen). ||
|| [beforedrag](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-beforedrag)| Event preceding the "drag" event. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- pixelOffset - Array of two numbers that describe the pixel offset at this step.
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.
Names of methods that are accessible via [Event.callMethod](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#callMethod): 
- setPixelOffset - This method is for correcting the value of the pixel offset that will 	actually be applied. It takes an argument with the new pixel offset in the form of an array of two numbers.
If the [Event.preventDefault](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#preventDefault) method is called for this event, a subsequent drag event will be canceled.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-beforedrag). ||
|| [beforedragstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-beforedragstart)| Event preceding the "dragstart" event. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.
If the [Event.preventDefault](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#preventDefault) method is called for this event, any subsequent dragging, as well as the "dragstart" event, will be canceled.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-beforedragstart). ||
|| [click](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-click)| Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md).

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-click). ||
|| [contextmenu](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu)| Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md).

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu). ||
|| [dblclick](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick)| Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md).

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick). ||
|| [drag](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-drag)| Dragging a geo object. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- pixelOffset - Array of two numbers that describe the pixel offset at this step.
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-drag). ||
|| [dragend](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-dragend)| End of geo object dragging. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-dragend). ||
|| [dragstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-dragstart)| Start of geo object dragging. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-dragstart). ||
|| [editorstatechange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-editorstatechange)| Change in the state of the editor for the geo object's geometry. 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: 
- originalEvent - Original event of the geometry editor.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-editorstatechange). ||
|| [geometrychange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-geometrychange)| Change to the geo object geometry. 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: 
- originalEvent: [IEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEvent.md) - Original event of the geometry.

Inherited from [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-geometrychange). ||
|| [hintclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-hintclose)| Closing the hint. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-hintclose). ||
|| [hintopen](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-hintopen)| Opening a hint on a geo object. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class.

Inherited from [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-hintopen). ||
|| [mapchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md#event-mapchange)| Map reference changed. Data fields: 
- oldMap - Old map.
- newMap - New map.

Inherited from [IParentOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md#event-mapchange). ||
|| [mousedown](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown)| Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md).

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown). ||
|| [mouseenter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter)| Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md).

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter). ||
|| [mouseleave](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave)| Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md).

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave). ||
|| [mousemove](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove)| Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md).

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove). ||
|| [mouseup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup)| Letting go of the mouse button over an object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md).

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup). ||
|| [multitouchend](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend)| End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface.

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend). ||
|| [multitouchmove](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove)| Repeating event during multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields: 
- clientX - X coordinate of the touch relative to the viewable area of the browser.
- clientY - Y coordinate of the touch relative to the viewable area of the browser.
- pageX - X coordinate of the touch relative to the beginning of the document.
- pageY - Y coordinate of the touch relative to the beginning of the document.

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove). ||
|| [multitouchstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart)| Start of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields: 
- clientX - X coordinate of the touch relative to the viewable area of the browser.
- clientY - Y coordinate of the touch relative to the viewable area of the browser.
- pageX - X coordinate of the touch relative to the beginning of the document.
- pageY - Y coordinate of the touch relative to the beginning of the document.

Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart). ||
|| [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). ||
|| [overlaychange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-overlaychange)| Change to the geo object overlay. 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: 
- overlay: [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md)\|null - Reference to the overlay.
- oldOverlay: [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md)\|null - Previous overlay of the geo object.

Inherited from [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-overlaychange). ||
|| [parentchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChild.md#event-parentchange)| The parent object reference changed.

Data fields:

- oldParent - Old parent.
- newParent - New parent.

Inherited from [IChild](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChild.md#event-parentchange). ||
|| [propertieschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-propertieschange)| Change to the geo object data. 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: 
- originalEvent: [IEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEvent.md) - Original event of the data manager.

Inherited from [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-propertieschange). ||
|| [wheel](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-wheel)| Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md).

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

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [getMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md#getMap)() | [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Map.md)
| Returns reference to the map.

Inherited from [IParentOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md#getMap). ||
|| [getOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#getOverlay)() | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md)
| Returns the promise object, which is confirmed by the overlay object at the time it is actually created, or is rejected with an appropriate error message.

Inherited from [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#getOverlay). ||
|| [getOverlaySync](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#getOverlaySync)() | [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md)\|null
| The method provides synchronous access to the overlay.

Inherited from [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#getOverlaySync). ||
|| [getParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md)\|null
| Returns link to the parent object, or null if the parent element was not set.

Inherited from [IChildOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#getParent). ||
|| [setParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md)
| Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object.

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

## Fields details {#field_detail}

### editor {#editor}

```javascript
{geometryEditor.Circle} editor
```

The "Circle" geometry editor.

### geometry {#geometry}

```javascript
{geometry.Circle} geometry
```

The "Circle" type of geometry.

### indices {#indices}

```javascript
{ArrayBuffer} indices
```

### vertices {#vertices}

```javascript
{ArrayBuffer} vertices
```

[*star]: Mandatory parameter/option.