arcgis-maps-kotlin/com.arcgismaps.analysis/LocationDistanceMeasurement

LocationDistanceMeasurement

class LocationDistanceMeasurement : Analysis

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

Constructors

fun LocationDistanceMeasurement(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

directDistance

val directDistance: Distance?

endLocation

var endLocation: Point?

horizontalDistance

val horizontalDistance: Distance?

isVisible

var isVisible: Boolean

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.

measurementChanged

val measurementChanged: SharedFlow<LocationDistanceMeasurementChanged>

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

startLocation

var startLocation: Point?

unitSystem

var unitSystem: UnitSystem

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

verticalDistance

val verticalDistance: Distance?

LocationDistanceMeasurement

See also

Constructors

Properties