MeasureViewModel

new IonSdkMeasurements.MeasureViewModel(options)

A widget for making ephemeral measurements.
Name Type Description
options Object An object with the following properties:
Name Type Default Description
scene Scene The scene
units MeasureUnits optional The 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
primitives PrimitiveCollection optional A collection in which to store the measurement primitives
measurements Array optional An array of measurement constructors or descriptor objects specifying which tools to include, e.g. [DistanceMeasurement, { type: DistanceMeasurement, showComponentLines: true }, VerticalMeasurement]. Defaults to the standard measurement set.
cursor MeasurementCursor MeasurementCursor.DEFAULT optional The cursor style to use when a measurement tool is active.
snapping MeasurementSnapping | MeasurementSnapping.ConstructorOptions optional Snapping settings, shared by every tool. Client snapping is on by default.

Members

expanded : Boolean
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 119

Gets and sets whether the measurement toolbar is expanded.
Default Value: false

instructionsVisible : Boolean
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 146

Gets and sets whether the instructions are visible.
Default Value: false

readonly measurements : Array.<Measurement>
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 216

Gets the array of available measurement types.

readonly scene : Scene
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 205

Gets the scene.

selectedMeasurement : Measurement
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 153

Gets or sets the currently selected measurement. This property is observable.
Default Value: undefined

readonly snapping : MeasurementSnapping
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 227

Gets the snapping settings shared by every tool. Changes apply immediately.

units : MeasureUnits
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 237

Gets the selected unit of measurement.

Methods

destroy()
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 424

Destroys the widget view model.

isDestroyed() → Boolean
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 417

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

onMeasurementStateChange(callback) → function
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 318

Registers a callback that is invoked whenever the measurement state changes, so an external UI can stay in sync. The callback receives no arguments and fires on: a measurement's handleClick, handleDoubleClick, and handleKeyDown (if defined), the MultipleDistanceMeasurement measurementCompleted and measurementsCleared events, and MeasureViewModel#reset.
Name Type Description
callback function The function to call when the measurement state changes.
Returns:
A function that removes the registered callback. Call it to unsubscribe when the listener is no longer needed to avoid stale callbacks and memory leaks.

reset()
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 296

Resets the widget.

toggleActive()
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 251

Toggles the state of the toolbar.

toggleInstructions()
packages/ion-sdk-measurements/Source/Measure/MeasureViewModel.js 258

Toggles the visibility of the instructions panel.
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/core
@cesium/engine
@cesium/widgets