LengthsParameters
require(["esri/tasks/support/LengthsParameters"], function(LengthsParameters) { /* code goes here */ });esri/tasks/support/LengthsParametersSets the length units and other parameters for the GeometryService.lengths() operation.
Constructors
- new LengthsParameters(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | Defines the type of calculation for the geometry. more details | more details | LengthsParameters | |
| String | The name of the class. more details | more details | Accessor | |
| Boolean | If polylines are in a geographic coordinate system, then geodesic needs to be set to | more details | LengthsParameters | |
| Number | String | The length unit in which perimeters of polygons will be calculated. more details | more details | LengthsParameters | |
| Polyline[] | The array of polylines whose lengths are to be computed. more details | more details | LengthsParameters |
Property Details
- calculationTypeString
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.
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- geodesicBoolean
If polylines are in a geographic coordinate system, then geodesic needs to be set to
truein order to calculate the ellipsoidal shortest path distance between each pair of the vertices in the polylines. IflengthUnitis not specified, the output is returned in meters.
The length unit in which perimeters of polygons will be calculated. For a list of valid units, see linear unit codes.
- polylinesPolyline[]
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 | |
|---|---|---|---|---|
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | LengthsParameters |
Method Details
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.