new ol.geom.Polygon(coordinates, opt_layout)
| Name | Type | Description |
|---|---|---|
coordinates |
Array.<Array.<ol.Coordinate>> |
Array of linear rings that define the polygon. The first linear ring of the array defines the outer-boundary or surface of the polygon. Each subsequent linear ring defines a hole in the surface of the polygon. A linear ring is an array of vertices' coordinates where the first coordinate and the last are equivalent. |
layout |
ol.geom.GeometryLayout |
Layout. |
Fires:
-
change(ol.events.Event) - Generic change event. Triggered when the revision counter is increased. -
propertychange(ol.Object.Event) - Triggered when a property is changed.
Extends
Methods
-
ol.geom.Polygon.circular(sphere, center, radius, opt_n){ol.geom.Polygon}
src/ol/geom/polygon.js, line 381 -
Create an approximation of a circle on the surface of a sphere.
Name Type Description sphereol.Sphere The sphere.
centerol.Coordinate Center (
[lon, lat]in degrees).radiusnumber The great-circle distance from the center to the polygon vertices.
nnumber Optional number of vertices for the resulting polygon. Default is
32.Returns:
The "circular" polygon.
-
ol.geom.Polygon.fromCircle(circle, opt_sides, opt_angle){ol.geom.Polygon}
src/ol/geom/polygon.js, line 427 -
Create a regular polygon from a circle.
Name Type Description circleol.geom.Circle Circle geometry.
sidesnumber Number of sides of the polygon. Default is 32.
anglenumber Start angle for the first vertex of the polygon in radians. Default is 0.
Returns:
Polygon geometry.
-
Create a polygon from an extent. The layout used is
XY.Name Type Description extentol.Extent The extent.
Returns:
The polygon.
-
appendLinearRing(linearRing)
src/ol/geom/polygon.js, line 95 -
Append the passed linear ring to this polygon.
Name Type Description linearRingol.geom.LinearRing Linear ring.
-
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 transformFnol.TransformFunction Transform.
-
Increases the revision counter and dispatches a 'change' event.
-
Make a complete copy of the geometry.
Returns:
Clone.
-
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a
typeproperty.Name Type Description eventObject | ol.events.Event | string Event object.
-
Gets a value.
Name Type Description keystring Key name.
Returns:
Value.
-
getArea(){number}
src/ol/geom/polygon.js, line 153 -
Return the area of the polygon on projected plane.
Returns:
Area (on projected plane).
-
Return the closest point of the geometry to the passed point as
coordinate.Name Type Description pointol.Coordinate Point.
closestPointol.Coordinate Closest point.
Returns:
Closest point.
-
Get the coordinate array for this geometry. This array has the structure of a GeoJSON coordinate array for polygons.
Name Type Description rightboolean 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.
-
Get the extent of the geometry.
Name Type Description extentol.Extent Extent.
Returns:
extent Extent.
-
Return the first coordinate of the geometry.
Returns:
First coordinate.
-
Return an interior point of the polygon.
Returns:
Interior point as XYM coordinate, where M is the length of the horizontal intersection that the point belongs to.
-
Get a list of object property names.
Returns:
List of property names.
-
Return the last coordinate of the geometry.
Returns:
Last point.
-
Return the
layoutof the geometry.Returns:
Layout.
-
Return the Nth linear ring of the polygon geometry. Return
nullif the given index is out of range. The exterior linear ring is available at index0and the interior rings at index1and beyond.Name Type Description indexnumber Index.
Returns:
Linear ring.
-
getLinearRingCount(){number}
src/ol/geom/polygon.js, line 229 -
Return the number of rings of the polygon, this includes the exterior ring and any interior rings.
Returns:
Number of rings.
-
Return the linear rings of the polygon.
Returns:
Linear rings.
-
Get an object of all property names and values.
Returns:
Object.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
Get the type of this geometry.
Returns:
Geometry type.
-
Returns true if this geometry includes the specified coordinate. If the coordinate is on the boundary of the geometry, returns false.
Name Type Description coordinateol.Coordinate Coordinate.
Returns:
Contains coordinate.
-
intersectsExtent(extent){boolean}
src/ol/geom/polygon.js, line 329 -
Test if the geometry and the passed extent intersect.
Name Type Description extentol.Extent Extent.
Returns:
trueif the geometry and the extent intersect.
-
on(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 99 -
Listen for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
once(type, listener, opt_this){ol.EventsKey|Array.<ol.EventsKey>} inherited
src/ol/observable.js, line 124 -
Listen once for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object to use as
thisinlistener.Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
Rotate the geometry around a given coordinate. This modifies the geometry coordinates in place.
Name Type Description anglenumber Rotation angle in radians.
anchorol.Coordinate The rotation center.
-
Scale the geometry (with an optional origin). This modifies the geometry coordinates in place.
Name Type Description sxnumber The scaling factor in the x-direction.
synumber The scaling factor in the y-direction (defaults to sx).
anchorol.Coordinate The scale origin (defaults to the center of the geometry extent).
-
Sets a value.
Name Type Description keystring Key name.
value* Value.
silentboolean Update without triggering an event.
-
setCoordinates(coordinates, opt_layout)
src/ol/geom/polygon.js, line 342 -
Set the coordinates of the polygon.
Name Type Description coordinatesArray.<Array.<ol.Coordinate>> Coordinates.
layoutol.geom.GeometryLayout Layout.
-
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Name Type Description valuesObject.<string, *> Values.
silentboolean Update without triggering an event.
-
Create a simplified version of this geometry. For linestrings, this uses the the Douglas Peucker algorithm. For polygons, a quantization-based simplification is used to preserve topology.
Name Type Description tolerancenumber The tolerance distance for simplification.
Returns:
A new, simplified version of the original geometry.
-
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 sourceol.ProjectionLike The current projection. Can be a string identifier or a
ol.proj.Projectionobject.destinationol.ProjectionLike The desired projection. Can be a string identifier or a
ol.proj.Projectionobject.Returns:
This geometry. Note that original geometry is modified in place.
-
Translate the geometry. This modifies the geometry coordinates in place. If instead you want a new geometry, first
clone()this geometry.Name Type Description deltaXnumber Delta X.
deltaYnumber Delta Y.
-
Unlisten for a certain type of event.
Name Type Description typestring | Array.<string> The event type or array of event types.
listenerfunction The listener function.
thisObject The object which was used as
thisby thelistener. -
Unsets a property.
Name Type Description keystring Key name.
silentboolean Unset without triggering an event.
OpenLayers