new ol.geom.Circle(center, opt_radius, opt_layout) experimental
Name | Type | Description |
---|---|---|
center |
ol.Coordinate |
Center. |
radius |
number |
Radius. |
layout |
ol.geom.GeometryLayout |
Layout. |
Fires:
-
change
experimental - Triggered when the geometry changes. -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed.
Extends
Methods
-
applyTransform(transformFn) inherited
src/ol/geom/simplegeometry.js, line 260 -
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 dispatches a 'change' event.
Fires:
-
change
experimental
-
-
clone(){ol.geom.Circle} experimental
src/ol/geom/circle.js, line 38 -
Make a complete copy of the geometry.
Returns:
Clone.
-
get(key){*} inherited
src/ol/object.js, line 150 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getCenter(){ol.Coordinate} experimental
src/ol/geom/circle.js, line 92 -
Return the center of the circle as
coordinate
.Returns:
Center.
-
getClosestPoint(point, opt_closestPoint){ol.Coordinate} inherited
src/ol/geom/geometry.js, line 122 -
Return the closest point of the geometry to the passed point as
coordinate
.Name Type Description point
ol.Coordinate Point.
closestPoint
ol.Coordinate Closest point.
Returns:
Closest point.
-
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 112 -
Return the first coordinate of the geometry.
Returns:
First coordinate.
-
getKeys(){Array.<string>} inherited
src/ol/object.js, line 164 -
Get a list of object property names.
Returns:
List of property names.
-
getLastCoordinate(){ol.Coordinate} inherited
src/ol/geom/simplegeometry.js, line 130 -
Return the last coordinate of the geometry.
Returns:
Last point.
-
getLayout(){ol.geom.GeometryLayout} inherited
src/ol/geom/simplegeometry.js, line 140 -
Return the
layout
of the geometry.Returns:
Layout.
-
getProperties(){Object.<string, *>} inherited
src/ol/object.js, line 174 -
Get an object of all property names and values.
Returns:
Object.
-
getRadius(){number} experimental
src/ol/geom/circle.js, line 115 -
Return the radius of the circle.
Returns:
Radius.
-
getRevision(){number} inherited experimental
src/ol/observable.js, line 62 -
Returns:
Revision.
-
getType(){ol.geom.GeometryType} experimental
src/ol/geom/circle.js, line 135 -
Get the type of this geometry.
Returns:
Geometry type.
-
intersectsExtent(extent){boolean}
src/ol/geom/circle.js, line 144 -
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
inlistener
.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
inlistener
.Returns:
Unique key for the listener.
-
set(key, value) inherited
src/ol/object.js, line 203 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setCenter(center) experimental
src/ol/geom/circle.js, line 168 -
Set the center of the circle as
coordinate
.Name Type Description center
ol.Coordinate Center.
-
setCenterAndRadius(center, radius, opt_layout) experimental
src/ol/geom/circle.js, line 191 -
Set the center (as
coordinate
) and the radius (as number) of the circle.Name Type Description center
ol.Coordinate Center.
radius
number Radius.
layout
ol.geom.GeometryLayout Layout.
-
setProperties(values) inherited
src/ol/object.js, line 216 -
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Name Type Description values
Object.<string, *> Values.
-
setRadius(radius) experimental
src/ol/geom/circle.js, line 231 -
Set the radius of the circle. 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 261 -
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]
. Thistransform
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
src/ol/geom/simplegeometry.js, line 272 -
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.
-
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 thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 114 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
. -
unset(key) inherited
src/ol/object.js, line 229 -
Unsets a property.
Name Type Description key
string Key name.