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 379

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

Name	Type	Description
sphere	ol.Sphere	The sphere.
center	ol.Coordinate	Center ([lon, lat] in degrees).
radius	number	The great-circle distance from the center to the polygon vertices.
n	number	Optional number of vertices for the resulting polygon. Default is 32.

Returns:

The "circular" polygon.

ol.geom.Polygon.fromExtent(extent){ol.geom.Polygon} experimental

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

Create a polygon from an extent. The layout used is XY.

Name	Type	Description
extent	ol.Extent	The extent.

Returns:

The polygon.

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 243

Apply a transform function to each coordinate 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	ol.TransformFunction	Transform.

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:

• change experimental

clone(){ol.geom.Polygon}

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

Make a complete copy of the geometry.

Returns:

Clone.

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(opt_right){Array.<Array.<ol.Coordinate>>}

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

Get the coordinate array for this geometry. This array has the structure of a GeoJSON coordinate array for polygons.

Name	Type	Description
right	boolean	Orient coordinates according to the right-hand rule (counter-clockwise for exterior and clockwise for interior rings). If false, coordinates will be oriented according to the left-hand rule (clockwise for exterior and counter-clockwise for interior rings). By default, coordinate orientation will depend on how the geometry was constructed.

Returns:

Coordinates.

getExtent(opt_extent){ol.Extent} inherited

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

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 104

Returns:

First coordinate.

getInteriorPoint(){ol.geom.Point}

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

Returns:

Interior point.

getLastCoordinate(){ol.Coordinate} inherited

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

Returns:

Last point.

getLayout(){ol.geom.GeometryLayout} inherited

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

Returns:

Layout.

getLinearRing(index){ol.geom.LinearRing}

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

Return the Nth linear ring of the polygon geometry. Return null if the given index is out of range. The exterior linear ring is available at index 0 and the interior rings at index 1 and beyond.

Name	Type	Description
index	number	Index.

Returns:

Linear ring.

getLinearRingCount(){number} experimental

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

Return the number of rings of the polygon, this includes the exterior ring and any interior rings.

Returns:

Number of rings.

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

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

Returns:

Linear rings.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62

Returns:

Revision.

getType(){ol.geom.GeometryType}

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

Get the type of this geometry.

Returns:

Geometry type.

intersectsExtent(extent){boolean} experimental

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

Test if the geometry and the passed extent intersect.

Name	Type	Description
extent	ol.Extent	Extent.

Returns:

true if the geometry and the extent intersect.

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

src/ol/observable.js, line 75

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 88

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 332

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 235

Transform each coordinate of the geometry from one coordinate reference system to another. The geometry is modified in place. For example, a line will be transformed to a line and a circle to a circle. 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.

translate(deltaX, deltaY) inherited experimental

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

Translate the geometry.

Name	Type	Description
deltaX	number	Delta X.
deltaY	number	Delta Y.

un(type, listener, opt_this) inherited

src/ol/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.
this	Object	The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 114

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name	Type	Description
key	goog.events.Key	The key returned by on() or once().