LengthsParameters | References | ArcGIS Maps SDK for JavaScript

import LengthsParameters from "@arcgis/core/rest/support/LengthsParameters.js";

Inheritance:: LengthsParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

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

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`LengthsParametersProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`calculationType`	`"planar" \| "geodesic" \| "preserve-shape" \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`geodesic`	`boolean \| null \| undefined`
`lengthUnit`	`number \| string`
`polylines`	`Polyline[] \| null \| undefined`

calculationType

Property

Type: "planar" | "geodesic" | "preserve-shape" | null | undefined

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.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

geodesic

Property

Type: boolean | null | undefined

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

Property

Type: number | string

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

polylines

autocast Property

Type: Polyline[] | null | undefined

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.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.