DistanceParameters | References | ArcGIS Maps SDK for JavaScript

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

Defines the input parameters when calling distance().

See also

Constructors

Parameter	Type	Description	Required
properties	`DistanceParametersProperties`

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

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

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`distanceUnit`	`GeometryOperationLengthUnit \| null \| undefined`
`geodesic`	`boolean \| null \| undefined`
`geometry1`	`GeometryUnion \| null \| undefined`
`geometry2`	`GeometryUnion \| null \| undefined`

readonlyinherited Property

Inherited from: Accessor

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

Property

Specifies the units for measuring distance between geometry1 and geometry2. If the unit is not specified the units are derived from the spatial reference. For a list of valid units, see esriSRUnitType Constants and esriSRUnit2Type Constants.

Property

When true, the geodesic distance between geometry1 and geometry2 is measured.

autocast Property

The geometry from which the distance is to be measured. The geometry can be a Point, Polyline, Polygon, or a Multipoint.

autocast Property

The geometry to which the distance is to be measured. The geometry can be a Point, Polyline, Polygon, or a Multipoint.

Method	Signature	Class
`toJSON`	`toJSON(): object`

Method

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

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