Class: Circle

Extends

• module:ol/geom/SimpleGeometry~SimpleGeometry

Methods

applyTransform(transformFn) inherited

geom/SimpleGeometry.js, line 198

Apply a transform function to the coordinates 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 function. Called with a flat array of geometry coordinates.

changed() inherited

Observable.js, line 36

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

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

geom/Circle.js, line 42

Make a complete copy of the geometry.

Returns:

Clone.

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 96

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
event	Object | module:ol/events/Event~BaseEvent | string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 119

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

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

geom/Circle.js, line 89

Return the center of the circle as coordinate.

Returns:

Center.

getClosestPoint(point, opt_closestPoint){module:ol/coordinate~Coordinate} inherited

geom/Geometry.js, line 129

Return the closest point of the geometry to the passed point as coordinate.

Name	Type	Description
point	module:ol/coordinate~Coordinate	Point.
closestPoint	module:ol/coordinate~Coordinate	Closest point.

Returns:

Closest point.

getExtent(opt_extent){module:ol/extent~Extent} inherited

geom/Geometry.js, line 162

Get the extent of the geometry.

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

Returns:

extent Extent.

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

geom/SimpleGeometry.js, line 64

Return the first coordinate of the geometry.

Returns:

First coordinate.

getKeys(){Array.<string>} inherited

Object.js, line 132

Get a list of object property names.

Returns:

List of property names.

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

geom/SimpleGeometry.js, line 80

Return the last coordinate of the geometry.

Returns:

Last point.

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

geom/SimpleGeometry.js, line 89

Return the layout of the geometry.

Returns:

Layout.

getProperties(){Object.<string, *>} inherited

Object.js, line 141

Get an object of all property names and values.

Returns:

Object.

getRadius(){number}

geom/Circle.js, line 110

Return the radius of the circle.

Returns:

Radius.

getRevision(){number} inherited

Observable.js, line 47

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

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

geom/Circle.js, line 128

Get the type of this geometry.

Returns:

Geometry type.

intersectsCoordinate(coordinate){boolean} inherited

geom/Geometry.js, line 142

Returns true if this geometry includes the specified coordinate. If the coordinate is on the boundary of the geometry, returns false.

Name	Type	Description
coordinate	module:ol/coordinate~Coordinate	Coordinate.

Returns:

Contains coordinate.

intersectsExtent(extent){boolean}

geom/Circle.js, line 136

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.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 60

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.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 82

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.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

rotate(angle, anchor) inherited

geom/SimpleGeometry.js, line 212

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 233

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).

set(key, value, opt_silent) inherited

Object.js, line 164

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.
silent	boolean	Update without triggering an event.

setCenter(center)

geom/Circle.js, line 159

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 179

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.

setProperties(values, opt_silent) inherited

Object.js, line 183

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.
silent	boolean	Update without triggering an event.

setRadius(radius)

geom/Circle.js, line 213

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

Name	Type	Description
radius	number	Radius.

simplify(tolerance){module:ol/geom/Geometry~Geometry} inherited

geom/Geometry.js, line 206

Create a simplified version of this geometry. For linestrings, this uses the Douglas Peucker algorithm. For polygons, a quantization-based simplification is used to preserve topology.

Name	Type	Description
tolerance	number	The tolerance distance for simplification.

Returns:

A new, simplified version of the original geometry.

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

geom/Circle.js, line 265

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 259

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) inherited

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.

unset(key, opt_silent) inherited

Object.js, line 195

Unsets a property.

Name	Type	Description
key	string	Key name.
silent	boolean	Unset without triggering an event.