LocationDistanceMeasurement

An analysis object that evaluates direct, vertical, and horizontal distances between two points defined by start and end point locations. LocationDistanceMeasurement measures the distance between a start and an end location (each using Point geometry). 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

Since

200.1.0

Constructors

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

Creates a LocationDistanceMeasurement analysis object that defines a start and an end location using Point objects. The LocationDistanceMeasurement 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 LocationDistanceMeasurement. The direct distance length measurement component. Will return 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 LocationDistanceMeasurement. The point coordinates (x,y,z) define the end location in 3D space.

Link copied to clipboard

The horizontal distance component of the LocationDistanceMeasurement. The horizontal distance length measurement component. Will return null if valid start and end locations have not been set, or if an error occurs.

Link copied to clipboard

Sets the callback to invoke when any of the LocationDistanceMeasurement distance components change.

Link copied to clipboard

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

Link copied to clipboard

The Unit System of the LocationDistanceMeasurement. The Unit System under which distances are calculated. Will return UnitSystem.Metric if an error occurs.

Link copied to clipboard

The vertical distance component of the LocationDistanceMeasurement. The vertical distance length measurement component. Will return 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 an Analysis is visible. Visibility can be controlled for individual Analyses as well as for the AnalysisOverlay that contains them. Will return false if an error occurs.