ol.geom. ol.geom.Circle

new Circle

Stability: experimental
Parameters:
Name Type Argument Description
center ol.geom.RawPoint

Center.

radius number <optional>

Radius.

layout ol.geom.GeometryLayout <optional>

Layout.

Source:
  • circle.js, line 19

Extends

Members

getType

Stability: experimental
Inherited From:
Source:
  • geometry.js, line 148

Methods

dispatchChangeEvent

Stability: experimental
Inherited From:
Source:
  • observable.js, line 35

getCenter

Stability: experimental
Source:
  • circle.js, line 83
Returns:

Center.

Type
ol.geom.RawPoint

getClosestPoint

Stability: experimental
Parameters:
Name Type Argument Description
point ol.Coordinate

Point.

closestPoint ol.Coordinate <optional>

Closest point.

Inherited From:
Source:
  • geometry.js, line 103
Returns:

Closest point.

Type
ol.Coordinate

getFirstCoordinate

Stability: not documented
Inherited From:
Source:
  • simplegeometry.js, line 105
Returns:

First coordinate.

Type
ol.Coordinate

getLastCoordinate

Stability: not documented
Inherited From:
Source:
  • simplegeometry.js, line 121
Returns:

Last point.

Type
ol.Coordinate

getLayout

Stability: experimental
Inherited From:
Source:
  • simplegeometry.js, line 130
Returns:

Layout.

Type
ol.geom.GeometryLayout

getRadius

Stability: experimental
Source:
  • circle.js, line 110
Returns:

Radius.

Type
number

on

Stability: experimental

Listen for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>

The object to use as this in listener.

Inherited From:
Source:
  • observable.js, line 58
Returns:

Unique key for the listener.

Type
goog.events.Key

once

Stability: experimental

Listen once for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>

The object to use as this in listener.

Inherited From:
Source:
  • observable.js, line 71
Returns:

Unique key for the listener.

Type
goog.events.Key

setCenter

Stability: experimental
Parameters:
Name Type Description
center ol.geom.RawPoint

Center.

Source:
  • circle.js, line 146

setCenterAndRadius

Stability: experimental
Parameters:
Name Type Argument Description
center ol.geom.RawPoint

Center.

radius number

Radius.

layout ol.geom.GeometryLayout <optional>

Layout.

Source:
  • circle.js, line 166

setRadius

Stability: experimental
Parameters:
Name Type Description
radius number

Radius.

Source:
  • circle.js, line 205

un

Stability: experimental

Unlisten for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>

The object to use as this in listener.

Inherited From:
Source:
  • observable.js, line 83

unByKey

Stability: experimental

Removes an event listener using the key returned by on() or once().

Parameters:
Name Type Description
key goog.events.Key

Key.

Inherited From:
Source:
  • observable.js, line 93