Class: Polygon

Extends

• ol.geom.SimpleGeometry

Methods

ol.geom.Polygon.circular(sphere, center, radius, opt_n){ol.geom.Polygon}

src/ol/geom/polygon.js, line 332

Create an approximation of a circle on the surface of a sphere.

Name	Type	Description
sphere	ol.Sphere	The sphere.
center	ol.Coordinate	Center.
radius	number	Radius.
n	number	Optional number of points. Default is 32.

Returns:

Circle geometry.

appendLinearRing(linearRing)

src/ol/geom/polygon.js, line 89

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

applyTransform(transformFn) inherited

src/ol/geom/simplegeometry.js, line 249

Apply a transform function to the geometry. Modifies the geometry 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.

clone(){ol.geom.Polygon}

src/ol/geom/polygon.js, line 106

Make a complete copy of the geometry.

Returns:

Clone.

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:

• change experimental

getArea(){number}

src/ol/geom/polygon.js, line 147

Returns:

Area (on projected plane).

getClosestPoint(point, opt_closestPoint){ol.Coordinate} inherited

src/ol/geom/geometry.js, line 120

Name	Type	Description
point	ol.Coordinate	Point.
closestPoint	ol.Coordinate	Closest point.

Returns:

Closest point.

getCoordinates(){Array.<Array.<ol.Coordinate>>}

src/ol/geom/polygon.js, line 157

Returns:

Coordinates.

getExtent(opt_extent){ol.Extent} inherited

src/ol/geom/simplegeometry.js, line 95

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 111

Returns:

First coordinate.

getInteriorPoint(){ol.geom.Point}

src/ol/geom/polygon.js, line 190

Returns:

Interior point.

getLastCoordinate(){ol.Coordinate} inherited

src/ol/geom/simplegeometry.js, line 128

Returns:

Last point.

getLayout(){ol.geom.GeometryLayout} inherited

src/ol/geom/simplegeometry.js, line 137

Returns:

Layout.

getLinearRing(index){ol.geom.LinearRing}

src/ol/geom/polygon.js, line 200

Name	Type	Description
index	number	Index.

Returns:

Linear ring.

getLinearRings(){Array.<ol.geom.LinearRing>}

src/ol/geom/polygon.js, line 216

Returns:

Linear rings.

getRevision(){number} inherited experimental

src/ol/observable.js, line 52

Returns:

Revision.

getType(){ol.geom.GeometryType}

src/ol/geom/polygon.js, line 277

Get the type of this geometry.

Returns:

Geometry type.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 65

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 in listener.

Returns:

Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 78

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 in listener.

Returns:

Unique key for the listener.

setCoordinates(coordinates, opt_layout)

src/ol/geom/polygon.js, line 287

Name	Type	Description
coordinates	Array.<Array.<ol.Coordinate>>	Coordinates.
layout	ol.geom.GeometryLayout	Layout.

transform(source, destination){ol.geom.Geometry} inherited

src/ol/geom/geometry.js, line 200

Transform a geometry from one coordinate reference system to another. Modifies the geometry 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
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.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

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 the listener.

unByKey(key) inherited

src/ol/observable.js, line 101

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

Name	Type	Description
key	goog.events.Key	Key.