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. -
propertychange
(ol.ObjectEvent) - 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 391 -
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.fromCircle(circle, opt_sides, opt_angle){ol.geom.Polygon} experimental
src/ol/geom/polygon.js, line 437 -
Create a regular polygon from a circle.
Name Type Description circle
ol.geom.Circle Circle geometry.
sides
number Number of sides of the polygon. Default is 32.
angle
number Start angle for the first vertex of the polygon in radians. Default is 0.
Returns:
Polygon geometry.
-
ol.geom.Polygon.fromExtent(extent){ol.geom.Polygon} experimental
src/ol/geom/polygon.js, line 414 -
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 92 -
Append the passed linear ring to this polygon.
Name Type Description linearRing
ol.geom.LinearRing Linear ring.
-
applyTransform(transformFn) inherited
src/ol/geom/simplegeometry.js, line 260 -
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 dispatches a 'change' event.
Fires:
-
change
experimental
-
-
clone(){ol.geom.Polygon}
src/ol/geom/polygon.js, line 110 -
Make a complete copy of the geometry.
Returns:
Clone.
-
get(key){*} inherited
src/ol/object.js, line 150 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getArea(){number}
src/ol/geom/polygon.js, line 152 -
Return the area of the polygon on projected plane.
Returns:
Area (on projected plane).
-
getClosestPoint(point, opt_closestPoint){ol.Coordinate} inherited
src/ol/geom/geometry.js, line 122 -
Return the closest point of the geometry to the passed point as
coordinate
.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 171 -
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.
-
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 112 -
Return the first coordinate of the geometry.
Returns:
First coordinate.
-
getInteriorPoint(){ol.geom.Point}
src/ol/geom/polygon.js, line 214 -
Return an interior point of the polygon.
Returns:
Interior point.
-
getKeys(){Array.<string>} inherited
src/ol/object.js, line 164 -
Get a list of object property names.
Returns:
List of property names.
-
getLastCoordinate(){ol.Coordinate} inherited
src/ol/geom/simplegeometry.js, line 130 -
Return the last coordinate of the geometry.
Returns:
Last point.
-
getLayout(){ol.geom.GeometryLayout} inherited
src/ol/geom/simplegeometry.js, line 140 -
Return the
layout
of the geometry.Returns:
Layout.
-
getLinearRing(index){ol.geom.LinearRing}
src/ol/geom/polygon.js, line 241 -
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 index0
and the interior rings at index1
and beyond.Name Type Description index
number Index.
Returns:
Linear ring.
-
getLinearRingCount(){number} experimental
src/ol/geom/polygon.js, line 226 -
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 259 -
Return the linear rings of the polygon.
Returns:
Linear rings.
-
getProperties(){Object.<string, *>} inherited
src/ol/object.js, line 174 -
Get an object of all property names and values.
Returns:
Object.
-
getRevision(){number} inherited experimental
src/ol/observable.js, line 62 -
Returns:
Revision.
-
getType(){ol.geom.GeometryType}
src/ol/geom/polygon.js, line 320 -
Get the type of this geometry.
Returns:
Geometry type.
-
intersectsExtent(extent){boolean}
src/ol/geom/polygon.js, line 329 -
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
inlistener
.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
inlistener
.Returns:
Unique key for the listener.
-
set(key, value) inherited
src/ol/object.js, line 203 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setCoordinates(coordinates, opt_layout)
src/ol/geom/polygon.js, line 341 -
Set the coordinates of the polygon.
Name Type Description coordinates
Array.<Array.<ol.Coordinate>> Coordinates.
layout
ol.geom.GeometryLayout Layout.
-
setProperties(values) inherited
src/ol/object.js, line 216 -
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 values
Object.<string, *> Values.
-
translate(deltaX, deltaY) inherited
src/ol/geom/simplegeometry.js, line 272 -
Translate the geometry. This modifies the geometry coordinates in place. If instead you want a new geometry, first
clone()
this 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 thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 114 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
. -
unset(key) inherited
src/ol/object.js, line 229 -
Unsets a property.
Name Type Description key
string Key name.