MeasureViewModel

new IonSdkMeasurements.MeasureViewModel(options)

A widget for making ephemeral measurements.
Name Type Description
options Object An object with the following properties:
Name Type 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

Members

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

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

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

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

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

Gets the array of available measurement types.

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

Gets the scene.

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

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

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

Gets the selected unit of measurement.

Methods

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

Destroys the widget view model.

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

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

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

Resets the widget.

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

Toggles the state of the toolbar.

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

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.
packages/ion-sdk-measurements
packages/ion-sdk-sensors
packages/ion-sdk-geometry
@cesium/engine
@cesium/widgets