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 revision counter is increased. -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed.
Extends
Methods
-
applyTransform(transformFn) inherited
-
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
-
Increases the revision counter and dispatches a 'change' event.
-
clone(){ol.geom.Circle} experimental
-
Make a complete copy of the geometry.
Returns:
Clone.
-
get(key){*} inherited
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getCenter(){ol.Coordinate} experimental
-
Return the center of the circle as
coordinate
.Returns:
Center.
-
getClosestPoint(point, opt_closestPoint){ol.Coordinate} inherited
-
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
-
Return the first coordinate of the geometry.
Returns:
First coordinate.
-
getKeys(){Array.<string>} inherited
-
Get a list of object property names.
Returns:
List of property names.
-
getLastCoordinate(){ol.Coordinate} inherited
-
Return the last coordinate of the geometry.
Returns:
Last point.
-
getLayout(){ol.geom.GeometryLayout} inherited
-
Return the
layout
of the geometry.Returns:
Layout.
-
getProperties(){Object.<string, *>} inherited
-
Get an object of all property names and values.
Returns:
Object.
-
getRadius(){number} experimental
-
Return the radius of the circle.
Returns:
Radius.
-
getRevision(){number} inherited experimental
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
getType(){ol.geom.GeometryType} experimental
-
Get the type of this geometry.
Returns:
Geometry type.
-
intersectsExtent(extent){boolean}
-
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
-
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
-
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
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setCenter(center) experimental
-
Set the center of the circle as
coordinate
.Name Type Description center
ol.Coordinate Center.
-
setCenterAndRadius(center, radius, opt_layout) experimental
-
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
-
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
-
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}
-
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
-
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
-
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
-
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
-
Unsets a property.
Name Type Description key
string Key name.