Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: Polygon
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.geometry.Polygon")
Description
(Added at v1.0)
An array of rings where each ring is an array of points. The first and last points of a ring must be the same.Samples
Search for samples that use this class.Class hierarchy
esri/geometry.Geometry |_esri/geometry.Polygon
Subclasses
Constructors
| Name | Summary |
|---|---|
| new esri.geometry.Polygon(spatialReference) | Creates a new Polygon object. |
| new esri.geometry.Polygon(json) | Creates a new Polygon object using a JSON object. |
| new esri.geometry.Polygon(coordinates) | Create a new polygon by providing an array of geographic coordinate pairs. |
Properties
| Name | Type | Summary |
|---|---|---|
| cache | Object | The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. |
| rings | Number[][][] | An array of rings. |
| spatialReference | SpatialReference | The spatial reference of the geometry. |
| type | String | The type of geometry. |
Methods
| Name | Return type | Summary |
|---|---|---|
| addRing(ring) | Polygon | Adds a ring to the Polygon. |
| clearCache() | None | Sets the cache property to undefined. |
| contains(point) | Boolean | Checks on the client if the specified point is inside the polygon. |
| fromExtent(extent) | Polygon | Returns a new Polygon with one ring containing points equivalent to the coordinates of the extent.
Note: This is a static method. |
| getCacheValue(name) | Object | Returns the value for a named property stored in the cache. |
| getCentroid() | Point | Returns the centroid of the polygon as defined here. |
| getExtent() | Extent | Returns the extent of the polygon. |
| getPoint(ringIndex, pointIndex) | Point | Returns a point specified by a ring and point in the path. |
| insertPoint(ringIndex, pointIndex, point) | Polygon | Inserts a new point into a polygon. |
| isClockwise(ring) | Boolean | Checks if a Polygon ring is clockwise. |
| isSelfIntersecting(polygon) | Boolean | When true, the polygon is self-intersecting which means that the ring of the polygon crosses itself. |
| removePoint(ringIndex, pointIndex) | Point | Remove a point from the polygon at the given pointIndex within the ring identified by ringIndex. |
| removeRing(ringIndex) | Point[] | Removes a ring from the Polygon. |
| setCacheValue(name, value) | None | Sets the value for a named property stored in the cache. |
| setPoint(ringIndex, pointIndex, point) | Polygon | Updates a point in a polygon. |
| setSpatialReference(sr) | Geometry | Sets the spatial reference. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new Polygon object.
Parameters:
< |
Required | Spatial reference of the geometry. |
Sample:
var poly = new esri.geometry.Polygon(new esri.SpatialReference({wkid:4326}));
Creates a new Polygon object using a JSON object.
Parameters:
< |
Required | JSON object representing the geometry. |
Sample:
var polygonJson = {"rings":[[[-122.63,45.52],[-122.57,45.53],[-122.52,45.50],[-122.49,45.48],
[-122.64,45.49],[-122.63,45.52],[-122.63,45.52]]],"spatialReference":{"wkid":4326 }};
var polygon = new esri.geometry.Polygon(polygonJson);
Create a new polygon by providing an array of geographic coordinate pairs. For a single ring polygon specify an array of coordinate pairs. For a multi-ring polygon specify an array of array coordinate pairs. (Added at v3.6)
Parameters:
< |
Required | An array of geographic coordinates that define the polygon. |
Property Details
<Object
ObjectThe cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. An example is the extent of a polygon. The default value is
undefined. (Added at v3.13)Default value:
undefined<Number[][][]
Number[][][]An array of rings. Each ring is made up of three or more points.
See also: addRing()
<SpatialReference
SpatialReferenceThe spatial reference of the geometry. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
Method Details
Adds a ring to the Polygon. The ring can be one of the following: an array of numbers or an array of points. When added the index of the ring is incremented by one.
Return type:
PolygonParameters:
< |
Required | A polygon ring. |
Sample:
var polygon = new esri.geometry.Polygon(new esri.SpatialReference({wkid:4326}));
polygon.addRing([[-180,-90],[-180,90],[180,90],[180,-90],[-180,-90]]);
add points counter-clockwise to create a hole
polygon.addRing([[-83,35],[-74,35],[-74,41],[-83,41],[-83,35]]);
See also: rings
Checks on the client if the specified point is inside the polygon. A point on the polygon line is considered in.
Return type:
BooleanParameters:
< |
Required | The location defined by an X- and Y- coordinate in map units. |
Returns a new Polygon with one ring containing points equivalent to the coordinates of the extent.
Note: This is a static method.
(Added at v3.11)Return type:
PolygonParameters:
< |
Required | The Extent geometry to convert to a Polygon. |
Returns the value for a named property stored in the cache. (Added at v3.13)
Return type:
ObjectParameters:
< |
Required | The property name of the value to retrieve from the cache. |
Returns the centroid of the polygon as defined here. For a polygon with multiple rings, returns the centroid of the largest ring. Note: Polygon with holes supported as of version 3.8. (Added at v3.7)
Return type:
PointReturns the extent of the polygon.
Return type:
ExtentSample:
var taxLotExtent = selectedTaxLot.geometry.getExtent();
Returns a point specified by a ring and point in the path.
Return type:
PointInserts a new point into a polygon. (Added at v1.4)
Return type:
PolygonChecks if a Polygon ring is clockwise. Returns true for clockwise and false for counterclockwise.
Return type:
BooleanParameters:
< |
Required | A polygon ring. |
Sample:
var clockwise = esri.geometry.isClockwise(polygon.rings[0]);
When true, the polygon is self-intersecting which means that the ring of the polygon crosses itself. Also checks to see if polygon rings cross each other. (Added at v2.2)
Return type:
BooleanParameters:
< |
Required | The polygon to test for self-intersection. |
Sample:
var isIntersecting = new esri.geometry.polygonSelfIntersecting(polygon);
Remove a point from the polygon at the given pointIndex within the ring identified by ringIndex. (Added at v2.0)
Return type:
PointRemoves a ring from the Polygon. The index specifies which ring to remove.
Return type:
Point[]Parameters:
< |
Required | The index of the ring to remove. |
Sets the value for a named property stored in the cache. (Added at v3.13)
Updates a point in a polygon. (Added at v1.4)
Return type:
PolygonSets the spatial reference.
Return type:
GeometryParameters:
< |
Required | Spatial reference of the geometry. |