MultipleDistanceMeasurement

new IonSdkMeasurements.MultipleDistanceMeasurement(options)

Manages multiple distance measurements, allowing users to create and maintain multiple distance measurements simultaneously.
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 activeMeasurement : DistanceMeasurement
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 87

Gets the currently active (being drawn) measurement.

readonly count : Number
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 99

Gets the number of completed measurements.

readonly icon : String
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 111

Gets the icon for the measurement manager.

readonly id : String
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 160

Gets the id for the measurement manager.

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

Gets the instruction text for the measurement manager.

measurementCompleted : Event
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 50

An event that is fired when a measurement is completed.

readonly measurements : Array.<DistanceMeasurement>
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 75

Gets the array of all distance measurements.

measurementsCleared : Event
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 62

An event that is fired when all measurements are cleared.

measurementStarted : Event
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 56

An event that is fired when a measurement is started.

selectedUnits : MeasureUnits
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 171

Gets and sets the selected units of measurement.

readonly thumbnail : String
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 123

Gets the thumbnail for the measurement manager.

readonly type : String
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 135

Gets the type for the measurement manager.

Methods

clearAllAndDeactivate()
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 439

Clears all measurements and deactivates the manager without restarting. This is useful when completely clearing measurements via UI.

clearAllMeasurements()
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 462

Removes all completed measurements.

destroy()
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 505

Destroys the measurement manager and all its measurements.

handleClick(clickPosition)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 254

Handles click events for the measurement manager.
Name Type Description
clickPosition Cartesian2 The click position

handleDoubleClick(clickPosition)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 285

Handles double click events for the measurement manager.
Name Type Description
clickPosition Cartesian2 The click position

handleLeftDown(mousePosition)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 297

Handles left down mouse events for the measurement manager.
Name Type Description
mousePosition Cartesian2 The mouse position

handleLeftUp(mousePosition)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 309

Handles left up mouse events for the measurement manager.
Name Type Description
mousePosition Cartesian2 The mouse position

handleMouseMove(mousePosition)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 273

Handles mouse move events for the measurement manager.
Name Type Description
mousePosition Cartesian2 The mouse position

isDestroyed() → Boolean
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 498

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

removeMeasurement(measurement)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 424

Removes a specific measurement from the collection.
Name Type Description
measurement DistanceMeasurement The measurement to remove

reset()
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 479

Resets the measurement manager, clearing the active measurement but keeping completed ones.

setupEnhancedEscapeKeyHandler(deactivationCallback)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 323

Sets up an escape key handler for the completed and in-progress distance measurements. Priority behavior: 1. If a distance measurement is being drawn, cancel it 2. If completed distance measurements exist, remove the most recent one 3. If none remain, call the deactivation callback
Name Type Description
deactivationCallback function optional Optional callback when no distance measurements remain

stopCurrentMeasurement()
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 412

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