DistanceMeasurement

new IonSdkMeasurements.DistanceMeasurement(options)

Draws a measurement between two points.
Name Type Description
options Object An object with the following properties:
Name Type Default Description
scene Scene The scene
units MeasureUnits The selected units of measurement
locale String optional The BCP 47 language tag string customizing language-sensitive number formatting. If undefined, the runtime's default locale is used. See the Intl page on MDN
points PointPrimitiveCollection A collection for adding the point primitives
labels LabelCollection A collection for adding the labels
primitives PrimitiveCollection A collection for adding primitives
showComponentLines Boolean false optional Whether or not to show the x and y component lines

Members

readonly angleFromHorizontal : Number
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 224

Gets the angle between horizontal and the distance line in radians

readonly angleFromVertical : Number
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 235

Gets the angle between vertical and the distance line in radians

readonly distance : Number
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 191

Gets the distance of the measurement in meters

readonly horizontalDistance : Number
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 202

Gets the horizontal component of distance of the measurement in meters

readonly icon : String
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 246

Gets the icon.

readonly id : String
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 300

Gets the id.

readonly instructions : Array.<String>
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 288

Gets the instruction text.

showComponentLines : Boolean
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 314

Gets and sets whether or not to show the x and y component lines of the measurement.
Default Value: false

readonly thumbnail : String
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 260

Gets the thumbnail.

readonly type : String
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 274

Gets the type.

readonly verticalDistance : Number
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 213

Gets the vertical component of the distance of the measurement in meters

Methods

destroy()
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 672

Destroys the measurement.

handleClick(clickPosition)
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 561

Handles click events while drawing a distance measurement.
Name Type Description
clickPosition Cartesian2 The click position

handleMouseMove(mousePosition)
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 602

Handles mouse move events while drawing a distance measurement.
Name Type Description
mousePosition Cartesian2 The mouse position

isDestroyed() → Boolean
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 665

Returns:
true if the object has been destroyed, false otherwise.

reset()
packages/ion-sdk-measurements/Source/Measure/DistanceMeasurement.js 643

Resets the measurement.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/ion-sdk-measurements
packages/ion-sdk-sensors
packages/ion-sdk-geometry
@cesium/engine
@cesium/widgets