Defines the input parameters when calling GeometryService.distance().
Constructors
new DistanceParameters(properties)
properties Object See the properties for a list of all the properties that may be passed into the constructor. |
Property Overview
| Name | Type | Summary | |
|---|---|---|---|
| String | The name of the class. more details | more details | |
| String | Specifies the units for measuring distance between geometry1 and geometry2. more details | more details | |
| Boolean | When | more details | |
| Geometry[] | The geometry from which the distance is to be measured. more details | more details | |
| Geometry[] | The geometry to which the distance is to be measured. more details | more details | |
Property Details
declaredClassStringreadonly
The name of the class. The declared class name is formatted as
esri.folder.className.distanceUnitString
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
geodesicBoolean
geometry1Geometry[]
The geometry from which the distance is to be measured. The geometry can be a Point, Polyline, Polygon, or a Multipoint.
geometry2Geometry[]
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 | |
|---|---|---|---|
| Object | Converts an instance of this class to its ArcGIS Portal JSON representation. more details | more details | |
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.