---
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/ru/llms.txt

# Circle

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

Круг. Представляет собой геообъект с геометрией [geometry.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometry.Circle.md).

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

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

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

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

Создает экземпляр круга.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`geometry`](#param-geometry)[*](*star) | — | Тип: [ICircleGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICircleGeometry.md)\|Number[][]\|Object

Ссылка на объект геометрии точки или массив, первый элемент которого координаты центра круга, второй - радиус в метрах, или объект с параметрами геометрии. ||
|| [`properties`](#param-properties)| — | Тип: Object\|[IDataManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager.md)

Данные круга. Соответствуют данным класса [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md). Могут задаваться как экземпляр класса, реализующего интерфейс [IDataManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager.md), либо в виде хэша. При значениях опций по умолчанию кругу трактуются следующие поля данных:
- hintContent - содержимое всплывающей подсказки круга;
- balloonContent - содержимое балуна круга;
- balloonContentHeader - содержимое заголовка балуна круга;
- balloonContentBody - содержимое основой части балуна круга;
- balloonContentFooter - содержимое нижней части балуна круга.
Поле balloonContent является кратким обозначением для поля balloonContentBody, но при одновременном задании balloonContentBody более приоритетен. Также вы можете дополнить данные круга своими собственными полями и использовать их везде, где это возможно. Например, в макете круга или макете балуна. ||
|| [`options`](#param-options)| — | Тип: Object

Опции круга. Используя этот параметр можно задавать как опции самого круга, так и опции его составных частей:
- Опции [балуна](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Balloon.md#constructor-summary) круга с префиксом `balloon`.
- Опции [всплывающей подсказки](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Hint.md#constructor-summary) круга с префиксом `hint`.
- Опции редактора геометрии круга с префиксом `editor`. Смотрите описание класса [geometryEditor.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometryEditor.Circle.md).
- Опции геометрии могут задаваться без префикса. Смотрите описание класса [IGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeometry.md) геометрии [geometry.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometry.Circle.md). ||
|| [`options.circleOverlay`](#param-options.circleOverlay)| "default#circle" | Тип: String\|Function

Ключ-идентификатор из хранилища [overlay.storage](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/overlay.storage.md) или класс оверлея. Функция-генератор принимает три параметра:
- geometry: [IPixelCircleGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPixelCircleGeometry.md) - непосредственно пиксельная геометрия;
- data: Object - данные оверлея;
- options: Object - опции оверлея.
Функция возвращает объект [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md). ||
|| [`options.cursor`](#param-options.cursor)| "pointer" | Тип: String

Вид курсора над кругом. ||
|| [`options.draggable`](#param-options.draggable)| false | Тип: Boolean

Определяет возможность перетаскивания круга. ||
|| [`options.fill`](#param-options.fill)| true | Тип: Boolean

Наличие заливки фигуры. ||
|| [`options.fillColor`](#param-options.fillColor)| "0066ff99" | Тип: String

Цвет заливки. ||
|| [`options.fillImageHref`](#param-options.fillImageHref)| — | Тип: String

Фоновое изображение. При включении данной опции в режиме заливки **stretch** значение опции fillColor игнорируется. ||
|| [`options.fillMethod`](#param-options.fillMethod)| 'stretch' | Тип: String

Тип заливки фоном. Может принимать одно из двух значений:
- stretch - фоновое изображение растягивается по размеру оверлея.
- tile - Фоновое изображение повторяется без изменений размера. Аналог background-repeat в css. Можно использовать для заливки фигуры неким шаблоном. ||
|| [`options.fillOpacity`](#param-options.fillOpacity)| 1 | Тип: Number

Прозрачность заливки. ||
|| [`options.hasBalloon`](#param-options.hasBalloon)| true | Тип: Boolean

Определяет наличие поля balloon у круга. ||
|| [`options.hasHint`](#param-options.hasHint)| true | Тип: Boolean

Определяет наличие поля hint у круга. ||
|| [`options.hideIconOnBalloonOpen`](#param-options.hideIconOnBalloonOpen)| true | Тип: Boolean

Скрывать иконку при открытии балуна. ||
|| [`options.interactiveZIndex`](#param-options.interactiveZIndex)| false | Тип: Boolean

Включает режим автоматического изменения z-index круга в зависимости от его состояния. ||
|| [`options.interactivityModel`](#param-options.interactivityModel)| "default#geoObject" | Тип: String

Модель интерактивности. Доступные ключи и их значения перечислены в описании [interactivityModel.storage](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/interactivityModel.storage.md). ||
|| [`options.opacity`](#param-options.opacity)| 1 | Тип: Number

Прозрачность. ||
|| [`options.openBalloonOnClick`](#param-options.openBalloonOnClick)| true | Тип: Boolean

Определяет, показывать ли балун при щелчке на круге. ||
|| [`options.openEmptyBalloon`](#param-options.openEmptyBalloon)| false | Тип: Boolean

Определяет, показывать ли пустой балун при щелчке на круге. ||
|| [`options.openEmptyHint`](#param-options.openEmptyHint)| false | Тип: Boolean

Определяет, показывать ли пустой хинт при наведении указателя мыши на круг. ||
|| [`options.openHintOnHover`](#param-options.openHintOnHover)| true | Тип: Boolean

Определяет, показывать ли хинт при наведении указателя мыши на круг. ||
|| [`options.outline`](#param-options.outline)| true | Тип: Boolean

Наличие обводки круга. ||
|| [`options.pane`](#param-options.pane)| "areas" | Тип: String

Ключ пейна, в который помещается оверлей круга. ||
|| [`options.strokeColor`](#param-options.strokeColor)| "0066ffff" | Тип: String\|String[]

Цвет линии или обводки. Можно задать несколько значений для множественной обводки. ||
|| [`options.strokeOpacity`](#param-options.strokeOpacity)| 1 | Тип: Number\|Number[]

Прозрачность линии или обводки. Можно задать несколько значений для множественной обводки. ||
|| [`options.strokeStyle`](#param-options.strokeStyle)| — | Тип: String\|Object\|String\[]\|Object[]

Стиль линии или обводки. Доступные стили перечислены в объекте [graphics.style.stroke](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/graphics.style.stroke.md). ||
|| [`options.strokeWidth`](#param-options.strokeWidth)| 1 | Тип: Number\|Number[]

Толщина линии или обводки. Можно задать несколько значений для множественной обводки. ||
|| [`options.syncOverlayInit`](#param-options.syncOverlayInit)| false | Тип: Boolean

Включает синхронное добавление оверлея на карту. По умолчанию добавление оверлея осуществляется асинхронно, что позволяет предотвратить зависания браузера при добавлении на карту большого числа геообъектов. Однако, асинхронное добавление не позволяет получать доступ к оверлею сразу после добавления круга на карту. ||
|| [`options.useMapMarginInDragging`](#param-options.useMapMarginInDragging)| true | Тип: Boolean

При перетаскивании объекта к краю карты происходит автоматическое изменение центра карты. Нужно ли учитывать отступы карты при автоматическом смещении центра карты [map.margin.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Manager.md). ||
|| [`options.visible`](#param-options.visible)| true | Тип: Boolean

Определяет видимость круга. ||
|| [`options.zIndex`](#param-options.zIndex)| — | Тип: Number

z-index круга в обычном состоянии. Наименее приоритетный. ||
|| [`options.zIndexActive`](#param-options.zIndexActive)| — | Тип: Number

z-index круга с открытым балуном. Наиболее приоритетный. ||
|| [`options.zIndexDrag`](#param-options.zIndexDrag)| — | Тип: Number

z-index круга при перетаскивании. ||
|| [`options.zIndexHover`](#param-options.zIndexHover)| — | Тип: Number

z-index круга при наведении на него указателя мыши. ||
|#

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

**Пример:**

```javascript
// Создаем геодезический круг радиусом 1000 километров.
var circle = new ymaps.Circle([[50, 75], 1000000], {}, {
    geodesic: true
});
// Добавляем круг на карту.
myMap.geoObjects.add(circle);
```

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

#|
|| **Имя** | **Тип** | **Описание** ||
|| [balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#balloon) | [geoObject.Balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geoObject.Balloon.md) | Балун геообъекта.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#balloon).||
|| [editor](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Circle.md#editor) | [geometryEditor.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometryEditor.Circle.md) | Редактор геометрии "Круг".||
|| [events](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#events) | [event.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/event.Manager.md) | Менеджер событий.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#events).||
|| [geometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Circle.md#geometry) | [geometry.Circle](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geometry.Circle.md) | Геометрия типа "Круг".||
|| [hint](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#hint) | [geoObject.Hint](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geoObject.Hint.md) | Хинт геообъекта.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#hint).||
|| [indices](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Circle.md#indices) | ArrayBuffer ||
|| [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#options) | [option.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/option.Manager.md) | Менеджер опций геообъекта.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#options).||
|| [properties](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#properties) | [data.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Менеджер данных геообъекта.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#properties).||
|| [state](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#state) | [data.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Состояние геообъекта. Определяется следующими полями:
- active: Boolean - признак того, что на геообъекте открыт балун.
- hover: Boolean - признак того, что в данный момент на геообъект наведен указатель мыши;
- drag: Boolean - признак того, что в данный момент геообъект перетаскивается.

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

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

#|
|| **Имя** | **Описание** ||
|| [balloonclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-balloonclose) | Закрытие балуна. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-balloonclose).||
|| [balloonopen](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-balloonopen) | Открытие балуна на геообъекте. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-balloonopen).||
|| [beforedrag](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-beforedrag) | Событие, предшествующее событию drag. Экземпляр класса [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):
- position - координаты относительно документа. Массива вида [pageX, pageY];
- pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.
Имена методов, доступных через метод [Event.callMethod](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#callMethod):
- setPixelOffset - метод, позволяющий скорректировать значение пиксельного сдвига, который будет фактически применен. В качестве аргумента принимает новый пиксельный сдвиг в виде массива из двух чисел.
Если у данного события вызвать метод [Event.preventDefault](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#preventDefault), то последующее событие "drag" будет отменено.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-beforedrag).||
|| [beforedragstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-beforedragstart) | Событие, предшествующее событию dragstart. Экземпляр класса [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):
- position - координаты относительно документа. Массива вида [pageX, pageY];
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.
Если у данного события вызвать метод [Event.preventDefault](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#preventDefault), то последующее перетаскивание, как и событие "dragstart", будет отменено.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-beforedragstart).||
|| [click](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click).||
|| [contextmenu](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu).||
|| [dblclick](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick).||
|| [drag](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-drag) | Перетаскивание геообъекта. Экземпляр класса [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):
- position - координаты относительно документа. Массива вида [pageX, pageY];
- pixelOffset - массив из двух чисел, описывающий пиксельный сдвиг на данном шаге;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-drag).||
|| [dragend](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-dragend) | Завершение перетаскивания геообъекта. Экземпляр класса [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):
- position - координаты относительно документа. Массива вида [pageX, pageY];
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-dragend).||
|| [dragstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-dragstart) | Начало перетаскивания геообъекта. Экземпляр класса [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):
- position - координаты относительно документа. Массива вида [pageX, pageY];
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-dragstart).||
|| [editorstatechange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-editorstatechange) | Изменение состояния редактора геометрии геообъекта. Экземпляр класса [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):
- originalEvent - оригинальное событие редактора геометрии.

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-editorstatechange).||
|| [geometrychange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-geometrychange) | Изменение геометрии геообъекта. Экземпляр класса [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):
- originalEvent: [IEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md) - оригинальное событие геометрии.

Унаследовано от [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-geometrychange).||
|| [hintclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-hintclose) | Закрытие хинта. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-hintclose).||
|| [hintopen](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-hintopen) | Открытие хинта на геообъекте. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

Унаследовано от [GeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObject.md#event-hintopen).||
|| [mapchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange) | Сменилась карта. Поля данных:
- oldMap - старая карта;
- newMap - новая карта.

Унаследовано от [IParentOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange).||
|| [mousedown](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown).||
|| [mouseenter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter).||
|| [mouseleave](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave).||
|| [mousemove](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove).||
|| [mouseup](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup).||
|| [multitouchend](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent.

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend).||
|| [multitouchmove](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove).||
|| [multitouchstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.

Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart).||
|| [optionschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.

Унаследовано от [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange).||
|| [overlaychange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-overlaychange) | Изменение оверлея геообъекта. Экземпляр класса [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):
- overlay: [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null - ссылка на оверлей;
- oldOverlay: [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null - предыдущий оверлей геообъекта.

Унаследовано от [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-overlaychange).||
|| [parentchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект.

Поля данных:

- oldParent - старый родитель;
- newParent - новый родитель.

Унаследовано от [IChild](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange).||
|| [propertieschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-propertieschange) | Изменение данных геообъекта. Экземпляр класса [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):
- originalEvent: [IEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md) - оригинальное событие менеджера данных.

Унаследовано от [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-propertieschange).||
|| [wheel](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

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

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#getMap)() | [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает ссылку на карту.

Унаследован от [IParentOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#getMap).||
|| [getOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlay)() | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки.

Унаследован от [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlay).||
|| [getOverlaySync](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlaySync)() | [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null | Метод предоставляет синхронный доступ к оверлею.

Унаследован от [IGeoObject](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlaySync).||
|| [getParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md)\|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

Унаследован от [IChildOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent).||
|| [setParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

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

## Описание полей {#field_detail}

### editor {#editor}

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

Редактор геометрии "Круг".

### geometry {#geometry}

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

Геометрия типа "Круг".

### indices {#indices}

```javascript
{ArrayBuffer} indices
```

### vertices {#vertices}

```javascript
{ArrayBuffer} vertices
```

<!-- XLIFF_FARM_MjAxM2Nm_CACHING -->

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