Extends

• ol.geom.SimpleGeometry

Members

getType

Stability: experimental

Inherited From:

• ol.geom.Geometry#getType

Source:

• geometry.js, line 148

Methods

appendLinearRing

Stability: not documented

Parameters:

Name	Type	Description
linearRing	ol.geom.LinearRing	Linear ring.

Source:

• polygon.js, line 85

dispatchChangeEvent

Stability: experimental

Dispatches a change event. Register a listener for this event to get notified of changes.

Inherited From:

• ol.Observable#dispatchChangeEvent

Source:

• observable.js, line 39

Fires:

• event:change

getArea

Stability: experimental

Source:

• polygon.js, line 141

Returns:

Area.

Type

number

getClosestPoint

Stability: experimental

Parameters:

Name	Type	Argument	Description
point	ol.Coordinate		Point.
closestPoint	ol.Coordinate	<optional>	Closest point.

Inherited From:

• ol.geom.Geometry#getClosestPoint

Source:

• geometry.js, line 103

Returns:

Closest point.

Type

ol.Coordinate

getCoordinates

Stability: experimental

Source:

• polygon.js, line 151

Returns:

Coordinates.

Type

ol.geom.RawPolygon

getFirstCoordinate

Stability: not documented

Inherited From:

• ol.geom.SimpleGeometry#getFirstCoordinate

Source:

• simplegeometry.js, line 105

Returns:

First coordinate.

Type

ol.Coordinate

getInteriorPoint

Stability: not documented

Source:

• polygon.js, line 183

Returns:

Interior point.

Type

ol.geom.Point

getLastCoordinate

Stability: not documented

Inherited From:

• ol.geom.SimpleGeometry#getLastCoordinate

Source:

• simplegeometry.js, line 121

Returns:

Last point.

Type

ol.Coordinate

getLayout

Stability: experimental

Inherited From:

• ol.geom.SimpleGeometry#getLayout

Source:

• simplegeometry.js, line 130

Returns:

Layout.

Type

ol.geom.GeometryLayout

getLinearRing

Stability: not documented

Parameters:

Name	Type	Description
index	number	Index.

Source:

• polygon.js, line 192

Returns:

Linear ring.

Type

ol.geom.LinearRing

getLinearRings

Stability: experimental

Source:

• polygon.js, line 208

Returns:

Linear rings.

Type

Array.<ol.geom.LinearRing>

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:

• ol.Observable#on

Source:

• observable.js, line 62

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:

• ol.Observable#once

Source:

• observable.js, line 75

Returns:

Unique key for the listener.

Type

goog.events.Key

setCoordinates

Stability: experimental

Parameters:

Name	Type	Argument	Description
coordinates	ol.geom.RawPolygon		Coordinates.
layout	ol.geom.GeometryLayout	<optional>	Layout.

Source:

• polygon.js, line 278

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:

• ol.Observable#un

Source:

• observable.js, line 87

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:

• ol.Observable#unByKey

Source:

• observable.js, line 97