OpenLayers

Class: Circle

ol/geom/Circle~Circle 


import Circle from 'ol/geom/Circle';

Circle geometry.

new Circle(center, opt_radius, opt_layout)

geom/Circle.js, line 15
Name Type Description
center module:ol/coordinate~Coordinate

Center. For internal use, flat coordinates in combination with opt_layout and no opt_radius are also accepted.
radius number

Radius.
layout module:ol/geom/GeometryLayout

Layout.

Methods

clone(){module:ol/geom/Circle~Circle}

geom/Circle.js, line 40

Make a complete copy of the geometry.

Returns:
Clone.

getCenter(){module:ol/coordinate~Coordinate}

geom/Circle.js, line 87

Return the center of the circle as coordinate.

Returns:
Center.

getRadius(){number}

geom/Circle.js, line 108

Return the radius of the circle.

Returns:
Radius.

getType()

geom/Circle.js, line 126

intersectsExtent()

geom/Circle.js, line 134

setCenter(center)

geom/Circle.js, line 157

Set the center of the circle as coordinate.

Name Type Description
center module:ol/coordinate~Coordinate

Center.

setCenterAndRadius(center, radius, opt_layout)

geom/Circle.js, line 177

Set the center (as coordinate) and the radius (as number) of the circle.

Name Type Description
center module:ol/coordinate~Coordinate

Center.
radius number

Radius.
layout module:ol/geom/GeometryLayout

Layout.

setRadius(radius)

geom/Circle.js, line 209

Set the radius of the circle. The radius is in the units of the projection.

Name Type Description
radius number

Radius.

transform(source, destination){module:ol/geom/Circle~Circle}

geom/Circle.js, line 238

Transform each coordinate of the circle from one coordinate reference system to another. The geometry is modified in place. If you do not want the geometry modified in place, first clone() it and then use this function on the clone.

Internally a circle is currently represented by two points: the center of the circle [cx, cy], and the point to the right of the circle [cx + r, cy]. This transform function just transforms these two points. So the resulting geometry is also a circle, and that circle does not correspond to the shape that would be obtained by transforming every point of the original circle.

Name Type Description
source module:ol/proj~ProjectionLike

The current projection. Can be a string identifier or a module:ol/proj/Projection~Projection object.
destination module:ol/proj~ProjectionLike

The desired projection. Can be a string identifier or a module:ol/proj/Projection~Projection object.
Returns:
This geometry. Note that original geometry is modified in place.