AreasAndLengthsParameters

require(["esri/tasks/support/AreasAndLengthsParameters"], function(AreasAndLengthsParameters) { /* code goes here */ });
Class: esri/tasks/support/AreasAndLengthsParameters
Inheritance: AreasAndLengthsParameters Accessor
Since: ArcGIS API for JavaScript 4.0

Input parameters for the areasAndLengths() method on the GeometryService.

See also:

Constructors

new AreasAndLengthsParameters(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.
NameTypeSummaryClass
String

The area unit in which areas of polygons will be calculated.

more details
more detailsAreasAndLengthsParameters
String

Defines the type of calculation for the geometry.

more details
more detailsAreasAndLengthsParameters
String

The name of the class.

more details
more detailsAccessor
String

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

more details
more detailsAreasAndLengthsParameters
Polygon[]

Polygon geometries for which to compute areas and lengths.

more details
more detailsAreasAndLengthsParameters

Property Details

areaUnitString

The area unit in which areas of polygons will be calculated. Use the strings listed below or any other valid area unit.

Possible Values: acres | hectares | square-miles | square-kilometers | square-meters | square-feet | square-yards

calculationTypeString

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

ValueDescription
planarPlanar 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.
geodesicUse 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-shapeCalculate 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.

declaredClassStringreadonly inherited

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

lengthUnitString

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.

Possible Values: feet | kilometers | meters | miles | nautical-miles | yards

polygonsPolygon[]

Polygon geometries for which to compute areas and lengths.

Method Overview

NameReturn TypeSummaryClass
Object

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

more details
more detailsAreasAndLengthsParameters

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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.