Class: Circle

Extends

• module:ol/geom/SimpleGeometry~SimpleGeometry

Methods

applyTransform(transformFn) inherited

geom/SimpleGeometry.js, line 200

Apply a transform function to each coordinate of the geometry. 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.

Name	Type	Description
transformFn	module:ol/proj~TransformFunction	Transform.

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.

getFirstCoordinate(){module:ol/coordinate~Coordinate} inherited

geom/SimpleGeometry.js, line 65

Return the first coordinate of the geometry.

Returns:

First coordinate.

getLastCoordinate(){module:ol/coordinate~Coordinate} inherited

geom/SimpleGeometry.js, line 81

Return the last coordinate of the geometry.

Returns:

Last point.

getLayout(){module:ol/geom/Geometry~GeometryLayout} inherited

geom/SimpleGeometry.js, line 90

Return the layout of the geometry.

Returns:

Layout.

getRadius(){number}

geom/Circle.js, line 108

Return the radius of the circle.

Returns:

Radius.

getType(){module:ol/geom/GeometryType}

geom/Circle.js, line 126

Get the type of this geometry.

Returns:

Geometry type.

intersectsExtent(extent){boolean}

geom/Circle.js, line 134

Test if the geometry and the passed extent intersect.

Name	Type	Description
extent	module:ol/extent~Extent	Extent.

Returns:

true if the geometry and the extent intersect.

rotate(angle, anchor) inherited

geom/SimpleGeometry.js, line 211

Rotate the geometry around a given coordinate. This modifies the geometry coordinates in place.

Name	Type	Description
angle	number	Rotation angle in radians.
anchor	module:ol/coordinate~Coordinate	The rotation center.

scale(sx, opt_sy, opt_anchor) inherited

geom/SimpleGeometry.js, line 226

Scale the geometry (with an optional origin). This modifies the geometry coordinates in place.

Name	Type	Description
sx	number	The scaling factor in the x-direction.
sy	number	The scaling factor in the y-direction (defaults to sx).
anchor	module:ol/coordinate~Coordinate	The scale origin (defaults to the center of the geometry extent).

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 211

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 240

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.

translate(deltaX, deltaY) inherited

geom/SimpleGeometry.js, line 249

Translate the geometry. This modifies the geometry coordinates in place. If instead you want a new geometry, first clone() this geometry.

Name	Type	Description
deltaX	number	Delta X.
deltaY	number	Delta Y.