Areas and Lengths

URL:
https://<root>/Utilities/Geometry/GeometryServer/areasAndLengths
Methods:
GET
Version Introduced:
9.3

Description

The areasAndLengths operation is performed on a geometry service resource. This operation calculates areas and perimeter lengths for each polygon specified in the input array. The input polygon is simplified when the calculationType is not planar. You can provide arguments to the areasAndLengths operation as query parameters defined in the following parameters table.

Request parameters

ParameterDetails

polygons

Specifies the array of polygons whose areas and lengths are to be computed. The spatial reference of the polygons is specified by sr. The structure of each polygon in the array is the same as the structure of the JSON polygon objects returned by ArcGIS REST API.

JSON structures:

Syntax:

Use dark colors for code blocksCopy
1
2
3
{
  "geometries" : [ <geometry1>, <geometry1>, ..., <geometryN> ]
}

Example:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[
  {
    "rings" :
    [
      [[-117,34],[-116,34],[-117,33],[-117,34]],
      [[-115,44],[-114,43],[-115,43],[-115,44]]
    ]
  },
  {
    "rings" :
    [
      [[32,17],[31,17],[30,17],[30,16],[32,17]]
    ]
  }
]

For a large set of geometries, you can specify a URL to the input geometries stored in a JSON structure in a file on a public server. The expected format of the file's contents will be the same as that expected if the polygons were directly embedded in the request.

URL-based syntax

Use dark colors for code blocksCopy
1
polygons={"url":"<URL to file>"}

URL-based example

Use dark colors for code blocksCopy
1
polygons={"url":"https://<myserver>/<mygeometries>/<afile.txt>"}

sr

Specifies the well-known ID (WKID) of the spatial reference or a spatial reference JSON object for the input polygons. For a list of valid WKID values, see Using spatial references.

lengthUnit

Specifies the length unit used to calculate the perimeters of the polygons. The lengthUnit must be an integer representing the well-known id (WKID) of an esriUnits constant. If calculationType is planar, lengthUnit can be any WKID of an esriUnits constant. If lengthUnit is not specified, the units are derived from sr . If calculationType is not planar, lengthUnit must be a WKID of a linear esriUnits constant, such as esriSRUnit_Meter or esriSRUnit_SurveyMile . If lengthUnit is not specified, the units are meters. For a list of valid units, see esriSRUnitType Constants and esriSRUnit2Type Constant.

areaUnit

Specifies the area unit used to calculate the areas of the polygons. The areaUnit can be an integer representing the well-known id (WKID) of an esriUnits constant or an esriUnits constant directly in the form shown below. If calculationType is planar, areaUnit can be any esriUnits constant. If areaUnit is not specified, the units are derived from sr. If calculationType is not planar, areaUnit must be a linear esriUnits constant such as esriSRUnit_Meter or esriSRUnit_SurveyMile. If areaUnit is not specified, the units are meters. For a list of valid units, see esriSRUnitType Constants and esriSRUnit2Type Constant.

Additional Values for areaUnit : esriSquareInches | esriSquareFeet | esriSquareYards | esriAcres | esriSquareMiles | esriSquareMillimeters | esriSquareCentimeters | esriSquareDecimeters | esriSquareMeters | esriAres | esriHectares | esriSquareKilometers

Syntax

Use dark colors for code blocksCopy
1
{"areaUnit": "<esriAreaUnits>"}

Example

Use dark colors for code blocksCopy
1
{"areaUnit": "esriHectares"}

calculationType

Specifies the type defined for the area and length calculation of the input geometries. The type can be one of the following values:

  • planar — Planar measurements use 2D Euclidean distance to calculate area and length. Use this type only if the area or length needs to be calculated in the given spatial reference. Otherwise, use preserveShape .
  • geodesic — Use this type to calculate an area or length using only the vertices of the polygon and define the lines between the points as geodesic segments independent of the actual shape of the polygon. A geodesic segment is the shortest path between two points on an ellipsoid.
  • preserveShape — This type calculates the area or length of the geometry on the surface of the earth ellipsoid. The shape of the geometry in its coordinate system is preserved.

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

The following is a sample request URL for areasAndLengths demonstrating how the areas and lengths of two polygons are calculated. The lengths are returned in miles, and the areas are returned in acres:

Use dark colors for code blocksCopy
1
https://sampleserver6.arcgisonline.com/arcgis/rest/services/Utilities/Geometry/GeometryServer/areasAndLengths?sr=102009&polygons=[%7B%22rings%22:[[[-628833,206205],[-630269,192298],[-631848,173991],[-616471,341822],[-620213,301450],[-625923,237538],[-628833,206205]]]%7D,%7B%22rings%22:[[[0,0],[0,100000],[100000,100000],[100000,0],[0,0]]]%7D]&lengthUnit=9035&areaUnit=%7B%22areaUnit%22:%22esriAcres%22%7D&calculationType=preserveShape&f=html

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
{
  "areas": [ <area1>, <area2>, ..., <areaN> ],
  "lengths": [ <length1>, <length2>, ..., <lengthN> ]
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "areas": [
    2150.340979272913,
    2800449.740201426
  ],
  "lengths": [
    222.93213167603818,
    264.5927746444603
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.