Abstract Abstract boundsAbstract coordinateThe coordinate type this shape. This property is read only. An Error will be thrown when trying to assign to this property.
The focus point of this shape. This property is read only. An error will be thrown when trying to assign to this property. This property contains an object but should be treated with value semantics: changes to the shape will not be reflected in the focusPoint that was retrieved from this Polygon before the modification.
The number of points in the polygon
The spatial reference of this shape. This property is read only. An Error will be thrown when trying to assign to this property.
Determines whether a given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).
true when the given point is contained in this shape
Abstract contains2DCoordinatesDetermines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).
The x coordinate of the point for which containment must be checked
The y coordinate of the point for which containment must be checked
true when the given point is contained in this shape
Point with another spatial reference
Determines whether the given point is inside this shape. This method checks containment only in two dimensions: on the (x,y)-axis or the (lon,lat)-axis (depending on the spatial reference of the shape).
The point for which containment must be checked.
true when the given point is contained in this shape
Point with another spatial reference
Abstract copyIndicates whether this shape is equal to another.
the other shape this shape is compared with.
true if both shapes are equal, false otherwise.
Returns the point of the polygon at the given index. Any subsequent mutation on the point affects the polygon shape. Note: A new Point is returned on each function invocation that shares the same point representation of the polygon.
const pA = polygon.getPoint(0)
const pB = polygon.getPoint(0)
console.log(pA === pB) // false
pA.x = 100;
console.log(pA.x, pB.x, polygon.getPoint(0).x) // 100, 100, 100
The index of the point to be returned.
the point at the given index
Inserts a Point at a given position in this Polygon. The point must be defined in the same spatial reference as the polygon, otherwise an exception will be thrown.
The index at which the point must be inserted
The point to be inserted
InvalidReferenceError When the point's spatial reference does not correspond with the polygon's spatial reference.
ProgrammingError When the index is invalid (i.e. smaller than zero or larger than the amount of points in the polygon.
Moves the x and y coordinates of the point at the given index to the given coordinates. The z value remains unchanged.
The index of the point that must be removed.
x coordinate value
y coordinate value
ProgrammingError When the index is invalid (i.e. smaller than zero or larger than the index of the last point in the polygon
Moves the point at the given index to the given coordinates.
The index of the point that must be removed.
x coordinate value
y coordinate value
z coordinate value
ProgrammingError When the index is invalid (i.e. smaller than zero or larger than the index of the last point in the polygon
Removes a point at a given position in this Polygon. This method does not guarantee that the polygon remains valid, i.e. the polygon must at least have 3 points. Validity of the polygon can be checked with Polygon.isValid.
The index of the point that must be removed.
ProgrammingError When the index is invalid (i.e. smaller than zero or larger than the index of the last point in the polygon
Translates the point at the given index over the given vector in 2D or 3D space. A point is only translated in 3D space the z parameter is specified.
The index of the point that must be removed.
x coordinate value
y coordinate value
Optional z: numberz coordinate value
ProgrammingError When the index is invalid (i.e. smaller than zero or larger than the index of the last point in the polygon
A polygon is a shape that represents a closed polygon without holes. A polygon always is defined in a particular geographical reference (Geodetic reference or Grid Reference). A Polygon cannot be instantiated directly. It must be instantiated using createPolygon.