import DirectLineMeasurementAnalysis from "@arcgis/core/analysis/DirectLineMeasurementAnalysis.js";
const DirectLineMeasurementAnalysis = await $arcgis.import("@arcgis/core/analysis/DirectLineMeasurementAnalysis.js");
@arcgis/core/analysis/DirectLineMeasurementAnalysis
DirectLineMeasurementAnalysis computes the distance between two points and displays the measurement in a 3D SceneView.
To display a distance measurement between two points, create a new instance of DirectLineMeasurementAnalysis, add it to SceneView.analyses and set the startPoint and endPoint properties.
Use the DirectLineMeasurementAnalysisView3D to retrieve analysis results.
// create analysis
const directLineMeasurement = new DirectLineMeasurementAnalysis({
startPoint: new Point({ }),
endPoint: new Point({ }),
unit: "imperial"
});
// add to the scene view
sceneView.analyses.add(directLineMeasurement);
// retrieve measured results from analysis view once available
const analysisView = await sceneView.whenAnalysisView(directLineMeasurement);
await reactiveUtils.whenOnce(() => analysisView.result);
const result = analysisView.result;
To place the start and end points interactively, use the DirectLineMeasurementAnalysisView3D.place() method.
const abortController = new AbortController();
try {
await analysisView.place({ signal: abortController.signal });
} catch (error) {
if (error.name === "AbortError") {
console.log("Placement operation was cancelled.");
}
}
// cancel the placement operation at some later point
abortController.abort();
How distances are computed depends on the scene's spatial reference.
In geographic coordinate systems (GCS) and in Web Mercator:
- Direct distance is computed in a Euclidean manner, in an ECEF coordinate system (or equivalent on other planets);
- Horizontal distance is computed geodetically, taking into consideration the curvature of the planet;
- Vertical distance is computed as an elevation difference.
In projected coordinate systems (PCS), apart from Web Mercator, all three distances (direct, horizontal, and vertical) are computed in a Euclidean manner (in their respective PCS).
DirectLineMeasurementAnalysis visualizes and labels the direct, horizontal, and vertical distances When the distance between the points is greater than 100 kilometers, the measurement visualization is simplified, and in the analysis results only the horizontal and vertical distances are calculated.
Use the Direct Line Measurement 3D component to display a user interface for the direct line measurement analysis.
Known Limitation
This analysis is only supported in a 3D SceneView.
- See also
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 |
---|---|---|---|
The name of the class. | Accessor | ||
Ending point for the measurement. | DirectLineMeasurementAnalysis | ||
A user settable identifier for the analysis. | Analysis | ||
The origin of the analysis. | Analysis | ||
Starting point for the measurement. | DirectLineMeasurementAnalysis | ||
The type of analysis. | DirectLineMeasurementAnalysis | ||
An automatically generated unique identifier assigned to the instance. | Analysis | ||
Unit system (imperial, metric) or specific unit used for computing the distance. | DirectLineMeasurementAnalysis | ||
Indicates whether the analysis is ready to be computed and interacted with in the view. | DirectLineMeasurementAnalysis |
Property Details
-
Ending point for the measurement.
If the point has a z-value then this will be treated as an absolute value, otherwise the point will be aligned to the ground.
-
origin
InheritedPropertyorigin AnalysisOriginWebScene |null |undefinedautocast
Inherited from Analysis -
The origin of the analysis. The origin can be of type
web-scene
when the analysis was applied from the WebScene.initialViewProperties or a Slide.
-
Starting point for the measurement.
If the point has a z-value then this will be treated as an absolute value, otherwise the point will be aligned to the ground.
-
type
type Stringreadonly
-
The type of analysis. For direct line measurement analysis, this is always "direct-line-measurement".
For DirectLineMeasurementAnalysis the type is always "direct-line-measurement".
-
unit
unit SystemOrLengthUnit |null |undefined
-
Unit system (imperial, metric) or specific unit used for computing the distance.
-
valid
valid Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33DirectLineMeasurementAnalysis since 4.23, valid added at 4.33. -
Indicates whether the analysis is ready to be computed and interacted with in the view. It requires both the startPoint and endPoint to be set.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
this | Creates a deep clone of this object. | Analysis | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
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.
-
Inherited from Analysis
-
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
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 true
if 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");