DirectLineMeasurementAnalysisView3D | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Represents the analysis view of a DirectLineMeasurementAnalysis after it has been added to SceneView.analyses.

The DirectLineMeasurementAnalysisView3D is responsible for rendering a DirectLineMeasurementAnalysis using custom visualizations. The properties on the analysis view provide developers with the ability to query measured results.

The view for an analysis can be retrieved using SceneView.whenAnalysisView similar to how layer views are retrieved for layers using SceneView.whenLayerView.

// retrieve analysis view for analysis
const analysis = new DirectLineMeasurementAnalysis();
sceneView.analyses.add(analysis); // add to the scene view
const analysisView = await view.whenAnalysisView(analysis);

Property Overview

Type	Summary	Class
DirectLineMeasurementAnalysis	The direct line measurement analysis object associated with the analysis view.	DirectLineMeasurementAnalysisView3D
DirectLineMeasurementAnalysisResult	Result of the direct line measurement.	DirectLineMeasurementAnalysisView3D
String	The analysis view type.	DirectLineMeasurementAnalysisView3D
Boolean	When `true`, the analysis is visualized in the view.	DirectLineMeasurementAnalysisView3D

Property Details

analysis Property analysis DirectLineMeasurementAnalysisreadonly

The direct line measurement analysis object associated with the analysis view.

result Property result DirectLineMeasurementAnalysisResult

Result of the direct line measurement. Results are calculated asynchronously and should be watched for changes.

type Property type Stringreadonly

The analysis view type.

For DirectLineMeasurementAnalysisView3D the type is always "direct-line-measurement-view-3d".

visible Property visible Boolean

When true, the analysis is visualized in the view.

Type Definitions

DirectLineMeasurementAnalysisResult Type Definition DirectLineMeasurementAnalysisResult

Result obtained from a DirectLineMeasurementAnalysis.

Properties: mode String

Describes how the horizontalDistance is computed.

In euclidean mode, the horizontal distance is the 2D distance between the two points, computed in a Euclidean manner. This mode is used in scenes with projected coordinate systems (PCS), apart from Web Mercator.

In geodesic mode, the horizontal distance is computed geodetically. This mode is used in scenes with geographic coordinate systems (GCS) or in Web Mercator.

Possible Values:"euclidean"|"geodesic"

distance Length

DEPRECATED since 4.29: Use directDistance and horizontalDistance - Measured distance between the start and end points.

directDistance Length

The 3D distance between the two points that is computed in a Euclidean manner.

horizontalDistance Length

The 2D distance between the two points.

verticalDistance Length

The elevation difference between the two points.