Add basic docs for geom.polygon
This commit is contained in:
@@ -84,6 +84,7 @@ goog.inherits(ol.geom.Polygon, ol.geom.SimpleGeometry);
|
||||
|
||||
|
||||
/**
|
||||
* Append the passed linear ring to this polygon.
|
||||
* @param {ol.geom.LinearRing} linearRing Linear ring.
|
||||
* @api stable
|
||||
*/
|
||||
@@ -143,6 +144,7 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
|
||||
|
||||
|
||||
/**
|
||||
* Return the area of the polygon on projected plane.
|
||||
* @return {number} Area (on projected plane).
|
||||
* @api stable
|
||||
*/
|
||||
@@ -204,6 +206,7 @@ ol.geom.Polygon.prototype.getFlatInteriorPoint = function() {
|
||||
|
||||
|
||||
/**
|
||||
* Return an interior point of the polygon.
|
||||
* @return {ol.geom.Point} Interior point.
|
||||
* @api stable
|
||||
*/
|
||||
@@ -248,6 +251,7 @@ ol.geom.Polygon.prototype.getLinearRing = function(index) {
|
||||
|
||||
|
||||
/**
|
||||
* Return the linear rings of the polygon.
|
||||
* @return {Array.<ol.geom.LinearRing>} Linear rings.
|
||||
* @api stable
|
||||
*/
|
||||
@@ -328,6 +332,7 @@ ol.geom.Polygon.prototype.intersectsExtent = function(extent) {
|
||||
|
||||
|
||||
/**
|
||||
* Set the coordinates of the polygon.
|
||||
* @param {Array.<Array.<ol.Coordinate>>} coordinates Coordinates.
|
||||
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
|
||||
* @api stable
|
||||
|
||||
Reference in New Issue
Block a user