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:
|
Members
readonly activeMeasurement : DistanceMeasurement
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 105
Gets the currently active (being drawn) measurement.
readonly count : Number
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 117
Gets the number of completed measurements.
readonly icon : String
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 129
Gets the icon for the measurement manager.
readonly id : String
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 178
Gets the id for the measurement manager.
readonly instructions : Array.<String>
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 165
Gets the instruction text for the measurement manager.
measurementCompleted : Event
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 51
An event that is fired when a measurement is completed.
readonly measurements : Array.<DistanceMeasurement>
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 93
Gets the array of all distance measurements.
measurementsCleared : Event
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 63
An event that is fired when all measurements are cleared.
measurementStarted : Event
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 57
An event that is fired when a measurement is started.
selectedUnits : MeasureUnits
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 189
Gets and sets the selected units of measurement.
readonly thumbnail : String
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 141
Gets the thumbnail for the measurement manager.
readonly type : String
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 153
Gets the type for the measurement manager.
Methods
clearAllAndDeactivate()
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 462
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 485
Removes all completed measurements.
Destroys the measurement manager and all its measurements.
handleClick(clickPosition)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 277
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 308
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 320
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 332
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 296
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 521
Returns:
true if the object has been destroyed, false otherwise.
removeMeasurement(measurement)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 447
Removes a specific measurement from the collection.
| Name | Type | Description |
|---|---|---|
measurement |
DistanceMeasurement | The measurement to remove |
Resets the measurement manager, clearing the active measurement but keeping completed ones.
setupEnhancedEscapeKeyHandler(deactivationCallback)
packages/ion-sdk-measurements/Source/Measure/MultipleDistanceMeasurement.js 346
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 435
Stops the current active measurement without completing it.