--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/geometry.Circle.md --- # geometry.Circle Расширяет [ICircleGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometry.md). Геометрия "Круг". **См.:** [Circle](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Circle.md) ## Конструктор {#constructor} ```javascript geometry.Circle([coordinates[, radius[, options]]]) ``` **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `coordinates` | null | Тип: Number[]\|null Координаты центра круга. || || `radius` | 0 | Тип: Number Радиус круга в метрах. || || `options` | — | Тип: Object Опции геометрии. || || `options.geodesic` | false | Тип: Boolean Включает отображение с использованием геодезических линий. || || `options.pixelRendering` | "jumpy" | Тип: String Метод расчета пиксельных координат отображения в зацикленных проекциях. Опция может принимать одно из следующих значений: • jumpy - отображение располагается как можно ближе к центру области показа карты и может скачкообразно перемещается во время движения карты; • static - отображение всегда располагается в начальном мире и не перемещается при движении карты. || || `options.projection` | — | Тип: [IProjection](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IProjection.md) Проекция. || |# **Пример:** ```javascript // Создаем экземпляр класса геометрии круга (указываем координаты и радиус в метрах). var circleGeometry = new ymaps.geometry.Circle([30, 50], 10), // Создаем экземпляр класса геообъекта и передаем нашу геометрию в конструктор. circleGeoObject = new ymaps.GeoObject({ geometry: circleGeometry }); // Изменяем радиус геометрии через свойство geometry геообъекта. circleGeoObject.geometry.setRadius(5) // Или напрямую. circleGeometry.setRadius(5); // Также доступ к circleGeometry можно получить через circleGeoObject.geometry. ``` ## Поля {#fields} #| || **Имя** | **Тип** | **Описание** || || [events](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events). || || [options](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOptionManager.md) | Менеджер опций. Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options). || |# ## События {#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 - новый радиус. Унаследовано от [ICircleGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#change). || || [mapchange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#mapchange) | Сменилась карта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get: • oldMap - старая карта; • newMap - новая карта. Унаследовано от [IGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#mapchange). || || [optionschange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#optionschange) | Изменение в опциях объекта. Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#optionschange). || || [pixelgeometrychange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#pixelgeometrychange) | Изменилась пиксельная геометрия. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get: • oldPixelGeometry - старая пиксельная геометрия [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md); • newPixelGeometry - новая пиксельная геометрия [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md). Унаследовано от [IGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#pixelgeometrychange). || |# ## Методы {#method} #| || **Имя** | **Возвращает** | **Описание** || || [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 | Проверяет, лежит ли переданная точка внутри круга. Унаследован от [ICircleGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#contains). || || [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). || || [getBounds](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#getBounds)() | Number[][]\|null | Returns координаты двух противоположных углов области, охватывающей геометрию. Первый элемент массива - юго-западный угол области; второй элемент - северо-восточный угол соответственно. Унаследован от [IGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#getBounds). || || [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. Унаследован от [ICircleGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#getClosest). || || [getCoordinates](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#getCoordinates)() | Number[]\|null | Returns координаты центра круга. Унаследован от [ICircleGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#getCoordinates). || || [getMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#getMap)() | [Map](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Map.md)\|null | Returns текущую карту. Унаследован от [IGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#getMap). || || [getPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#getPixelGeometry)([[options](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#getPixelGeometry-param-options)]) | [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md) | Returns пиксельную геометрию, соответствующую данной геометрии, ее опциям и состоянию карты. Унаследован от [IGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#getPixelGeometry). || || [getRadius](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#getRadius)() | Number | Returns радиус круга. Унаследован от [ICircleGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#getRadius). || || [getType](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometry.md#getType)() | String | Returns строку "Circle". Унаследован от [ICircleGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometry.md#getType). || || [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) | Задает координаты центра круга. Унаследован от [ICircleGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#setCoordinates). || || [setMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#setMap)([map](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#setMap-param-map)) | | Задает карту. Унаследован от [IGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md#setMap). || || [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) | Задает радиус круга. Унаследован от [ICircleGeometryAccess](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICircleGeometryAccess.md#setRadius). || || [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). || |#