Lengths

Description

The lengths operation is performed on a geometry service resource. This operation calculates the 2D Euclidean or geodesic lengths of each polyline specified in the input array.

You can provide arguments to the lengths operation as query parameters defined in the following parameters table:

Request parameters

Parameter

Details

f

Description:  (Optional) The response format. The default response format is html.
Values:   html | json

polylines

Description: The array of polylines whose lengths are to be computed. The spatial reference of the polylines is specified by sr. The structure of each polyline in the array is the same as the structure of the JSON polyline objects returned by the ArcGIS REST API.

JSON structures:

Syntax:

[ <polyline1>, <polyline2>, ..., <polylineN> ]

Example:

[
 {
  "paths" : [
   [[-117,34],[-116,34],[-117,33]],
   [[-115,44],[-114,43],[-115,43]]
  ]
 },
 {
  "paths" : [
   [[32.49,17.83],[31.96,17.59],[30.87,17.01],[30.11,16.86]]
  ]
 }
]

URL based:

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 exactly the same as that expected if the polylines were directly embedded in the request.

Syntax: polylines={ "url" : "<URL to file>" }

Example: polylines={ "url" : "http://myserver/mygeometries/afile.txt" }

sr

Description: The well-known ID of the spatial reference or a spatial reference JSON object for the input polylines. For a list of valid WKID values, see Projected coordinate systems and Geographic coordinate systems.

lengthUnit

Description: The unit in which lengths of polylines will be calculated. If calculationType is planar, then lengthUnit can be any esriUnits constant. If calculationType is planar and lengthUnit is not specified, then the units are derived from sr. If calculationType is not planar, then lengthUnit must be a linear esriUnits constant such as esriSRUnit_Meter or esriSRUnit_SurveyMile. If calculationType is not planar and lengthUnit is not specified, then the units are meters.

For a list of valid units, see esriSRUnitType Constants and esriSRUnit2Type Constants.

geodesic

Deprecated at 10.1. Use the calculationType parameter instead.

Description: If polylines are in a geographic coordinate system, then geodesic needs to be set to true to calculate the ellipsoidal shortest path distance between each pair of the vertices in the polylines. If lengthUnit is not specified, then the output is always returned in meters.

calculationType

Description: calculationType defines the length calculation for the geometry. The type can be one of the following values:

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

Example usage

In this example, the lengths of two input polylines are calculated. The preserveShape calculation type is used. The result is given in kilometers.

http://sampleserver6.arcgisonline.com/ArcGIS/rest/services/Utilities/Geometry/GeometryServer/lengths?sr=4269&polylines=[{"paths":[[[-117,34],[-116,34],[-117,33]],[[-115,44],[-114,43],[-115,43]]]},{"paths":[[[32.49,17.83],[31.96,17.59],[30.87,17.01],[30.11,16.86]]]}]&lengthUnit=9036&calculationType=preserveShape

JSON response syntax

{
"lengths" : [ <length1>, <length2>, ..., <lengthN> ]
}

JSON response example

{
 "lengths": [
  456.04101753137257,
  277.29464412330174
 ]
}

9/13/2017