Class: Polygon

Extends

• ol.geom.SimpleGeometry

Methods

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

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

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 Optional number of points. Default is 32.

Returns:

Circle geometry.

appendLinearRing(linearRing) experimental

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

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

applyTransform(transformFn) inherited experimental

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

Apply a transform function to the geometry. Modifies the geometry in place.

Name	Type	Description
transformFn	ol.TransformFunction	Transform.

clone(){ol.geom.Geometry} experimental

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

Returns:

Clone.

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 41

Dispatches a change event.

Fires:

• change experimental

getArea(){number} experimental

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

Returns:

Area.

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

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

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

Returns:

Closest point.

getCoordinates(){ol.geom.RawPolygon} experimental

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

Returns:

Coordinates.

getExtent(opt_extent){ol.Extent} inherited experimental

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

Get the extent of the geometry.

Name	Type	Description
extent	ol.Extent	optional Extent.

Returns:

extent Extent.

getFirstCoordinate(){ol.Coordinate} inherited experimental

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

Returns:

First coordinate.

getInteriorPoint(){ol.geom.Point} experimental

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

Returns:

Interior point.

getLastCoordinate(){ol.Coordinate} inherited experimental

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

Returns:

Last point.

getLayout(){ol.geom.GeometryLayout} inherited experimental

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

Returns:

Layout.

getLinearRing(index){ol.geom.LinearRing} experimental

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

Name	Type	Description
index	number	Index.

Returns:

Linear ring.

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

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

Returns:

Linear rings.

getSimplifiedGeometry(squaredTolerance){ol.geom.Geometry} inherited experimental

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

Name	Type	Description
squaredTolerance	number	Squared tolerance.

Returns:

Simplified geometry.

getType(){ol.geom.GeometryType} experimental

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

Returns:

Geometry type.

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

src/ol/observable.js, line 63

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	optional The object to use as this in listener.

Returns:

Unique key for the listener.

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

src/ol/observable.js, line 76

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	optional The object to use as this in listener.

Returns:

Unique key for the listener.

setCoordinates(coordinates, opt_layout) experimental

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

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

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

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

Transform a geometry from one coordinate reference system to another. Modifies the geometry in place.

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 experimental

src/ol/observable.js, line 88

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	optional The object to use as this in listener.

unByKey(key) inherited experimental

src/ol/observable.js, line 98

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

Name	Type	Description
key	goog.events.Key	Key.