import AreasAndLengthsParameters from "@arcgis/core/rest/support/AreasAndLengthsParameters.js";const AreasAndLengthsParameters = await $arcgis.import("@arcgis/core/rest/support/AreasAndLengthsParameters.js");- Inheritance:
- AreasAndLengthsParameters→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.20
Input parameters for the areasAndLengths() method on the geometryService.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| | ||
declaredClass readonly inherited | ||
LengthUnit | null | undefined | | |
| |
areaUnit
- Type
- AreaUnitKebabCase | null | undefined
The area unit in which areas of polygons will be calculated. Use the strings listed below or any other valid area unit.
calculationType
- Type
- CalculationTypeKebabCase | 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 preserveShape. |
| 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. |
lengthUnit
- Type
- LengthUnit | null | undefined
The length unit in which perimeters of polygons will be calculated. Use one of the possible values listed below or any of the numeric codes for linear units.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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 | 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
- Signature
-
toJSON (): any
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.