require(["esri/rest/support/DistanceParameters"], (DistanceParameters) => { /* code goes here */ });
import DistanceParameters from "@arcgis/core/rest/support/DistanceParameters.js";
esri/rest/support/DistanceParameters
Defines the input parameters when calling geometryService.distance().
Constructors
-
Parameterproperties 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 | The name of the class. | Accessor | |
| String | Specifies the units for measuring distance between geometry1 and geometry2. | DistanceParameters | |
| Boolean | When | DistanceParameters | |
| Geometry | The geometry from which the distance is to be measured. | DistanceParameters | |
| Geometry | The geometry to which the distance is to be measured. | DistanceParameters |
Property Details
-
distanceUnit
PropertydistanceUnit String -
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.
Possible Values:"feet"|"kilometers"|"meters"|"miles"|"nautical-miles"|"yards"
-
geodesic
Propertygeodesic Boolean -
-
geometry1
Propertygeometry1 Geometry -
The geometry from which the distance is to be measured. The geometry can be a Point, Polyline, Polygon, or a Multipoint.
-
geometry2
Propertygeometry2 Geometry -
The geometry to which the distance is to be measured. The geometry can be a Point, Polyline, Polygon, or a Multipoint.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | DistanceParameters |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.