Class Polygon
A multipart shape used to represent an area.
Namespace: Esri.ArcGISRuntime.Geometry
Assembly: Esri.ArcGISRuntime.dll
Syntax
public class Polygon : Multipart
Remarks
Polygon geometries represent the shape and location of areas, for example, a country, island, or a lake. A polygon can be used as the geometry of features and graphics, or as input or output of tasks or geoprocessing operations, such as the output of a drive-time analysis or a Buffer(Geometry, Double) operation.
Each part of a multipart polygon is a series of connected Segment objects forming a closed ring. Each part must not cross any other part, but may lie completely inside or outside another part. For example, a polygon representing the state of Hawaii would comprise eight disjoint parts, one representing each island. A polygon representing the country of South Africa, which completely surrounds the enclave of Lesotho, would comprise two parts, one contained inside the other.
Like Polyline, the polygon class is a Multipart, which provides members for iterating the segments and map points of each part in a polygon. Unlike parts in a polyline, however, each part of a polygon defines a closed area, so the end map point of the last segment in the part is always in the same location as the start map point of the first segment, forming a closed boundary.
When defining a polygon part, there is no need to explicitly close it by repeating the start map point as the last map point. Polygons parts are always interpreted as enclosed areas by ArcGIS Runtime.
Interior rings to make donut polygons should be counter-clockwise in direction to have the correct topology.
If there is ever a doubt about the topological correctness of a polygon, call the Simplify(Geometry) method to correct any issues. This is especially true if you pass a polygon to ArcGIS Server for a geoprocessing task to avoid any ArcGIS Server errors being thrown or to rectify polygons that may be self-intersecting, have rings which are partially contained in each other, or contain incorrect ring orientations.
Polygons are based upon the parent Geometry class. The geometry object is immutable which means that you can not change its shape once it is created. If you need to create a new polygon or modify it once it has been created, use the PolygonBuilder class.
A polygon can be used as the geometry of a Feature or Graphic. To obtain the geometry on these objects, use Geometry.
Constructors
Name | Description |
---|---|
Polygon(IEnumerable<MapPoint>) | Initializes a new instance of the Polygon class. |
Polygon(IEnumerable<MapPoint>, SpatialReference) | Initializes a new instance of the Polygon class. |
Polygon(IEnumerable<Segment>) | Initializes a new instance of the Polygon class. |
Polygon(IEnumerable<Segment>, SpatialReference) | Initializes a new instance of the Polygon class. |
Polygon(IEnumerable<IEnumerable<MapPoint>>) | Initializes a new instance of the Polygon class. |
Polygon(IEnumerable<IEnumerable<MapPoint>>, SpatialReference) | Initializes a new instance of the Polygon class. |
Polygon(IEnumerable<IEnumerable<Segment>>) | Initializes a new instance of the Polygon class. |
Polygon(IEnumerable<IEnumerable<Segment>>, SpatialReference) | Initializes a new instance of the Polygon class. |
Properties
Name | Description |
---|---|
Dimension | Gets the number of dimensions for the geometry. |
GeometryType | Gets the geometry type. |
Methods
Name | Description |
---|---|
IsEqual(Geometry) | Compares two Polygon for equality. This will check for a matching SpatialReference and the content of Parts match. The order of parts must match too. |
ToPolyline() | Returns a Polyline representation of this polygon. |
ToString() | Returns a System.String that represents the current Object. |
Applies to
Target | Versions |
---|---|
.NET Standard 2.0 | 100.3 - 100.15 |
.NET 6.0 | 100.13 - 100.15 |
.NET 6.0 Windows | 100.13 - 100.15 |
.NET Framework | 100.0 - 100.15 |
.NET 5 | 100.10 - 100.12 |
.NET Core 3.1 | 100.7 - 100.12 |
Xamarin.Android | 100.0 - 100.15 |
Xamarin.iOS | 100.0 - 100.15 |
UWP | 100.0 - 100.15 |