Class: Circle

Extends

• ol.geom.SimpleGeometry

Methods

applyTransform(transformFn) inherited

src/ol/geom/simplegeometry.js, line 244

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	ol.TransformFunction	Transform.

changed() inherited experimental

src/ol/observable.js, line 52

Increases the revision counter and disptches a 'change' event.

Fires:

• change experimental

clone(){ol.geom.Circle} experimental

src/ol/geom/circle.js, line 37

Make a complete copy of the geometry.

Returns:

Clone.

getCenter(){ol.Coordinate} experimental

src/ol/geom/circle.js, line 90

Returns:

Center.

getClosestPoint(point, opt_closestPoint){ol.Coordinate} inherited

src/ol/geom/geometry.js, line 120

Name	Type	Description
point	ol.Coordinate	Point.
closestPoint	ol.Coordinate	Closest point.

Returns:

Closest point.

getExtent(opt_extent){ol.Extent} inherited

src/ol/geom/geometry.js, line 159

Get the extent of the geometry.

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

extent Extent.

getFirstCoordinate(){ol.Coordinate} inherited

src/ol/geom/simplegeometry.js, line 105

Returns:

First coordinate.

getLastCoordinate(){ol.Coordinate} inherited

src/ol/geom/simplegeometry.js, line 122

Returns:

Last point.

getLayout(){ol.geom.GeometryLayout} inherited

src/ol/geom/simplegeometry.js, line 131

Returns:

Layout.

getRadius(){number} experimental

src/ol/geom/circle.js, line 112

Returns:

Radius.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62

Returns:

Revision.

getType(){ol.geom.GeometryType}

src/ol/geom/circle.js, line 132

Get the type of this geometry.

Returns:

Geometry type.

intersectsExtent(extent){boolean} inherited experimental

src/ol/geom/geometry.js, line 207

Test if the geometry and the passed extent intersect.

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

true if the geometry and the extent intersect.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 75

Listen for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 88

Listen once for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object to use as this in listener.

Returns:

Unique key for the listener.

setCenter(center) experimental

src/ol/geom/circle.js, line 141

Name	Type	Description
center	ol.Coordinate	Center.

setCenterAndRadius(center, radius, opt_layout) experimental

src/ol/geom/circle.js, line 161

Name	Type	Description
center	ol.Coordinate	Center.
radius	number	Radius.
layout	ol.geom.GeometryLayout	Layout.

setRadius(radius) experimental

src/ol/geom/circle.js, line 201

The radius is in the units of the projection.

Name	Type	Description
radius	number	Radius.

transform(source, destination){ol.geom.Circle}

src/ol/geom/circle.js, line 230

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	ol.proj.ProjectionLike	The current projection. Can be a string identifier or a ol.proj.Projection object.
destination	ol.proj.ProjectionLike	The desired projection. Can be a string identifier or a ol.proj.Projection object.

Returns:

This geometry. Note that original geometry is modified in place.

translate(deltaX, deltaY) inherited experimental

src/ol/geom/simplegeometry.js, line 258

Translate the geometry.

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

un(type, listener, opt_this) inherited

src/ol/observable.js, line 101

Unlisten for a certain type of event.

Name	Type	Description
type	string | Array.<string>	The event type or array of event types.
listener	function	The listener function.
this	Object	The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 114

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name	Type	Description
key	goog.events.Key	The key returned by on() or once().