geometry.Circle
Extends ICircleGeometry.
The "Circle" geometry.
See Circle
Constructor | Fields | Events | Methods
Constructor
geometry.Circle([coordinates[, radius[, options]]])
Parameters:
Parameter |
Default value |
Description |
null |
Type: Number[]|null Coordinates of the center of the circle. |
|
0 |
Type: Number Radius of the circle in meters. |
|
— |
Type: Object Geometry options. |
|
false |
Type: Boolean Enables display using geodesic lines. |
|
"jumpy" |
Type: String Method for calculating pixel coordinates of the shape in cycled projections. This option accepts one of the following values:
|
|
— |
Type: IProjection Projection. |
Example:
// 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
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
||
Options manager. Inherited from ICustomizable. |
Events
Name |
Description |
Changed coordinates. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from ICircleGeometryAccess. |
|
Map reference changed. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeometry. |
|
Change to the object options. Inherited from ICustomizable. |
|
The pixel geometry changed. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeometry. |
Methods
Name |
Returns |
Description |
Boolean |
Checks whether the passed point is located inside the circle. Inherited from ICircleGeometryAccess. |
|
freeze() |
Switches the object to "frozen" mode. Inherited from IFreezable. |
|
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. |
|
Object |
Searches for a point on the circle closest to the anchorPosition. Inherited from ICircleGeometryAccess. |
|
Number[]|null |
Returns coordinates of the center of the circle. Inherited from ICircleGeometryAccess. |
|
getMap() |
Map|null |
Returns the current map. Inherited from IGeometry. |
Returns the pixel geometry corresponding to the given geometry, its options, and the map state. Inherited from IGeometry. |
||
Number |
Returns radius of the circle. Inherited from ICircleGeometryAccess. |
|
getType() |
String |
Returns the "Circle" string. Inherited from ICircleGeometry. |
isFrozen() |
Boolean |
Returns true if the object is in "frozen" mode, otherwise false. Inherited from IFreezable. |
Sets the coordinates of the center of the circle. Inherited from ICircleGeometryAccess. |
||
Sets the map. Inherited from IGeometry. |
||
Sets the radius of the circle. Inherited from ICircleGeometryAccess. |
||
unfreeze() |
Switches the object to active mode. Inherited from IFreezable. |