Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: DistanceParameters
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/DistanceParameters"], function(DistanceParameters) { /* code goes here */ });
Description
(Added at v2.0)
Input parameters for the distance method on the GeometryService. Geometry1 and geometry2 are required.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new DistanceParameters() | Creates a new DistanceParameters object. |
Properties
| Name | Type | Summary |
|---|---|---|
| distanceUnit | Number | String | Specifies the units for measuring distance between geometry1 and geometry2. |
| geodesic | Boolean | When true, the geodesic distance between geometry1 and geometry2 is measured. |
| geometry1 | Geometry | The geometry from which the distance is to be measured. |
| geometry2 | Geometry | The geometry to which the distance is measured. |
Constructor Details
Creates a new DistanceParameters object. The constructor takes no parameters.
Sample:
require([
"esri/tasks/DistanceParameters", ...
], function(DistanceParameters, ... ) {
var distParams = new DistanceParameters();
...
});
Property Details
Specifies the units for measuring distance between geometry1 and geometry2. See the constants table of GeometryService for a list of valid values. If the unit is not specified the units are derived from the spatial reference.
Sample:
require([
"esri/tasks/DistanceParameters", "esri/tasks/GeometryService", ...
], function(DistanceParameters, GeometryService, ... ) {
var distParams = new DistanceParameters();
distParams.distanceUnit = GeometryService.UNIT_STATUTE_MILE;
...
});
<Boolean
BooleanWhen true, the geodesic distance between geometry1 and geometry2 is measured.
Known values:
true | falseDefault value:
falseSample:
distParams.geodesic = true;
<Geometry
GeometryThe geometry from which the distance is to be measured. The geometry can be one of the following geometry types:
esriGeometryPoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryMultipoint.Sample:
distParams.geometry1 = inputPoints[inputPoints.length -2];
<Geometry
GeometryThe geometry to which the distance is measured. The geometry can be one of the following geometry types: esriGeometryPoint, esriGeometryPolyline, esriGeometryPolygon or esriGeometryMultipoint.
Sample:
distParams.geometry2 = inputPoints[inputPoints.length -1];