LengthsParameters

AMD: require(["esri/rest/support/LengthsParameters"], (LengthsParameters) => { /* code goes here */ });
ESM: import LengthsParameters from "@arcgis/core/rest/support/LengthsParameters";
Class: esri/rest/support/LengthsParameters
Inheritance: LengthsParameters Accessor
Since: ArcGIS API for JavaScript 4.0

Sets the length units and other parameters for the GeometryService.lengths() operation.

See also:

Constructors

new LengthsParameters(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

Defines the type of calculation for the geometry.

more detailsLengthsParameters
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

If polylines are in a geographic coordinate system, then geodesic needs to be set to true in order to calculate the ellipsoidal shortest path distance between each pair of the vertices in the polylines.

more detailsLengthsParameters
Number|Stringmore details

The length unit in which perimeters of polygons will be calculated.

more detailsLengthsParameters
Polyline[]more details

The array of polylines whose lengths are to be computed.

more detailsLengthsParameters

Property Details

calculationType String

Defines the type of calculation for the geometry. The type can be one of the following:

Value Description
planar Planar measurements use 2D Cartesian mathematics to calculate length. Use this type if the length needs to be calculated in the input spatial reference otherwise use preserve-shape.
geodesic Use this type to calculate an area or length using only the vertices of the polygon to define the lines connecting the vertices as geodesic segments independent of the actual shape of the polygon. Note: a geodesic segment is the shortest path between two points on an ellipsoid.
preserve-shape Calculate the area or length of the geometry on the surface of the Earth ellipsoid, for geometries defined in a projected or geographic coordinate system. This method preserves the shape of the geometry in its coordinate system which means the true area or length will be calculated for the geometry that is displayed on the map.

Possible Values:"planar"|"geodesic"|"preserve-shape"

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

geodesic Boolean

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

lengthUnit Number|String

The length unit in which perimeters of polygons will be calculated. For a list of valid units, see linear unit codes.

polylines Polyline[]

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

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsLengthsParameters
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsLengthsParameters

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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