DirectLineMeasurementAnalysis | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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 once available
const analysisView = await sceneView.whenAnalysisView(directLineMeasurement);
await reactiveUtils.whenOnce(() => analysisView.result);

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

DirectLineMeasurementAnalysis Constructor 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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Point	Ending point for the measurement.	DirectLineMeasurementAnalysis
Point	Starting point for the measurement.	DirectLineMeasurementAnalysis
SystemOrLengthUnit	Unit system (imperial, metric) or specific unit used for computing the distance.	DirectLineMeasurementAnalysis

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

endPoint Property 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 Property 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 Property unit SystemOrLengthUnit

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

Method Overview

Show inherited methods

Hide inherited methods

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.	DirectLineMeasurementAnalysis
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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.

clone Method 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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");