ExploratoryLocationDistanceMeasurement

An Analysis object that evaluates direct, vertical, and horizontal distances between two points defined by start and end point locations. Measures the distance between a start and an end location (each using Point).

Three distances components are calculated:

  • Direct distance - the direct distance between the start and end location

  • Horizontal distance - the horizontal component of the direct distance

  • Vertical distance - the vertical component of the direct distance

Exploratory analysis is performed using data at the current rendered resolution of a SceneView and not at the full resolution of the data. Exploratory analysis results cannot be displayed in a MapView or persisted. Use the GeometryEngine to make more accurate measurements based on input geometries.

Since

300.0.0

Constructors

Link copied to clipboard
constructor(startLocation: Point, endLocation: Point)

Creates an ExploratoryLocationDistanceMeasurement analysis object that defines a start and an end location using Point objects. The ExploratoryLocationDistanceMeasurement analysis result is a distance measurement between the start and end locations with direct, horizontal, and vertical components.

Properties

Link copied to clipboard

The direct distance component of the distance measurement. Returns null if valid start and end locations have not been set or if an error occurs.

Link copied to clipboard

The end location of the distance measurement. The point coordinates (x,y,z) define the end location in 3D space.

Link copied to clipboard

The horizontal distance component of the distance measurement. Returns null if valid start and end locations have not been set or if an error occurs.

Link copied to clipboard

A SharedFlow that emits changes to any of the ExploratoryLocationDistanceMeasurement distance components.

Link copied to clipboard

The start location of the distance measurement. The point coordinates (x,y,z) define the start location in 3D space.

Link copied to clipboard

The Unit System of the distance measurement. The Unit System under which distances are calculated, or UnitSystem.Metric if an error occurs.

Link copied to clipboard

The vertical distance component of the distance measurement. Returns null if valid start and end locations have not been set or if an error occurs.

Inherited properties

Link copied to clipboard

Whether or not the analysis is visible. Visibility can be controlled for individual analyses as well as for the AnalysisOverlay that contains them. Returns false if an error occurs.