DirectLineMeasurementAnalysisView3D

AMD: require(["esri/views/3d/analysis/DirectLineMeasurementAnalysisView3D"], (DirectLineMeasurementAnalysisView3D) => { /* code goes here */ });
ESM: import DirectLineMeasurementAnalysisView3D from "@arcgis/core/views/3d/analysis/DirectLineMeasurementAnalysisView3D";
Class: esri/views/3d/analysis/DirectLineMeasurementAnalysisView3D

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);

Constructors

new DirectLineMeasurementAnalysisView3D(properties)
Parameter:
properties Object
optional

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

Property Overview

Name Type Summary Class
DirectLineMeasurementAnalysismore details

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

more detailsDirectLineMeasurementAnalysisView3D
DirectLineMeasurementAnalysisResultmore details

Result of the direct line measurement.

more detailsDirectLineMeasurementAnalysisView3D
Stringmore details

The analysis view type.

more detailsDirectLineMeasurementAnalysisView3D
Booleanmore details

When true, the analysis is visualized in the view.

more detailsDirectLineMeasurementAnalysisView3D

Property Details

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

Result of the direct line measurement.

type Stringreadonly

The analysis view type.

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

visible Boolean

When true, the analysis is visualized in the view.

Type Definitions

DirectLineMeasurementAnalysisResult

Result obtained from a DirectLineMeasurementAnalysis. Whether the distance is euclidean or geodesic is specified by the mode property. Note: Euclidean measurement is exact only if the spatial reference of the scene view is WGS84 or WebMercator, otherwise it's approximated by a scalar factor derived from the spatial reference.

Properties:
mode String

Specifies whether the distance measurement uses euclidean or geodesic units.

Possible Values:"euclidean"|"geodesic"

distance Length

Measured distance between start and endpoint.

horizontalDistance Length

Horizontal distance measured as the euclidean distance between the point with higher elevation and the other point with its elevation changed to match the first point's elevation (moved along surface normal). Note: This is exact only if the spatial reference of the scene view is WGS84 or WebMercator, otherwise it's approximated by a scalar factor derived from the spatial reference.

verticalDistance Length

Vertical distance measured as the absolute difference of the elevation of the two points. Note: This is exact only if the spatial reference of the scene view is WGS84 or WebMercator, otherwise it's approximated by a scalar factor derived from the spatial reference.

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