DirectLineMeasurementAnalysis

AMD: require(["esri/analysis/DirectLineMeasurementAnalysis"], (DirectLineMeasurementAnalysis) => { /* code goes here */ });
ESM: import DirectLineMeasurementAnalysis from "@arcgis/core/analysis/DirectLineMeasurementAnalysis";
Class: esri/analysis/DirectLineMeasurementAnalysis
Inheritance: DirectLineMeasurementAnalysis Accessor
Since: ArcGIS API for JavaScript 4.23

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: pointA,
  endPoint: pointB,
  unit: "imperial"
});

// add to the scene view
sceneView.analyses.add(directLineMeasurement);

// retrieve measured results from analysis view
const analysisView = await sceneView.whenAnalysisView(directLineMeasurement);
await reactiveUtils.whenOnce(() => !analysisView.updating);

const result = analysisView.result;

StartPoint and endPoint on the DirectLineMeasurementAnalysis can only be set programmatically. However, combined with SceneView.hitTest or the SketchViewModel, this analysis can be used to create interactive experiences for end users.

Use the DirectLineMeasurement3D widget in order to add interactivity and allow users to change the geometry of the analysis.

Known Limitation

This analysis is only supported in a 3D SceneView.

See also:

Constructors

new DirectLineMeasurementAnalysis(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Pointmore details

Ending point for the measurement.

more detailsDirectLineMeasurementAnalysis
Pointmore details

Starting point for the measurement.

more detailsDirectLineMeasurementAnalysis
SystemOrLengthUnitmore details

Unit system (imperial, metric) or specific unit used for computing the distance.

more detailsDirectLineMeasurementAnalysis

Property Details

declaredClass Stringreadonly inherited

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

endPoint Pointautocast

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.

startPoint Pointautocast

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.

Unit system (imperial, metric) or specific unit used for computing the distance.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
thismore details

Creates a deep clone of this object.

more detailsDirectLineMeasurementAnalysis
more details

Adds one or more handles which are to be tied to the lifecycle of the object.

more detailsAccessor

Method Details

clone(){this}

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.

Returns:
Type Description
this A deep clone of the class instance that invoked this method.
own(handleOrHandles)inherited
Since: ArcGIS API for JavaScript 4.24

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.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
});

handle.remove();

// Assign a handle using own()
this.own(reactiveUtils.whenOnce(() => !view.updating)
  .then(() => {
    wkidSelect.disabled = false;
  }));
Parameter:
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.