Class: Polygon

ol.geom.Polygon

Polygon geometry.

new ol.geom.Polygon(coordinates, opt_layout)

Name Type Description
coordinates Array.<Array.<ol.Coordinate>>

Coordinates.

layout ol.geom.GeometryLayout

Layout.

Fires:
  • change - Triggered when the geometry changes.

Extends

Methods

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

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

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

Name Type Description
extent ol.Extent

The extent.

Returns:
The polygon.

appendLinearRing(linearRing)

Name Type Description
linearRing ol.geom.LinearRing

Linear ring.

applyTransform(transformFn) inherited

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

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

Fires:
  • change experimental

Make a complete copy of the geometry.

Returns:
Clone.

getArea(){number}

Returns:
Area (on projected plane).

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

Name Type Description
point ol.Coordinate

Point.

closestPoint ol.Coordinate

Closest point.

Returns:
Closest point.

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

Returns:
Coordinates.

Get the extent of the geometry.

Name Type Description
extent ol.Extent

Extent.

Returns:
extent Extent.
Returns:
First coordinate.
Returns:
Interior point.
Returns:
Last point.
Returns:
Layout.

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

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

Returns:
Number of rings.
Returns:
Linear rings.

getRevision(){number} inherited experimental

Returns:
Revision.

Get the type of this geometry.

Returns:
Geometry type.

intersectsExtent(extent){boolean} experimental

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

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

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)

Name Type Description
coordinates Array.<Array.<ol.Coordinate>>

Coordinates.

layout ol.geom.GeometryLayout

Layout.

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

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

Translate the geometry.

Name Type Description
deltaX number

Delta X.

deltaY number

Delta Y.

un(type, listener, opt_this) inherited

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.

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().