MeasureViewModel

SWVL new Cesium.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
Widgets/Measure/MeasureViewModel.js 76

Gets and sets whether the measurement toolbar is expanded.

Default Value: false

instructionsVisible : Boolean
Widgets/Measure/MeasureViewModel.js 103

Gets and sets whether the instructions are visible.

Default Value: false

readonly measurements : Array.<Measurement>
Widgets/Measure/MeasureViewModel.js 162

Gets the array of available measurement types.

readonly scene : Scene
Widgets/Measure/MeasureViewModel.js 151

Gets the scene.

selectedMeasurement : Measurement
Widgets/Measure/MeasureViewModel.js 110

Gets or sets the currently selected measurement. This property is observable.

Default Value: undefined

units : MeasureUnits
Widgets/Measure/MeasureViewModel.js 172

Gets the selected unit of measurement.

Methods

destroy()
Widgets/Measure/MeasureViewModel.js 243

Destroys the widget view model.

isDestroyed() → Boolean
Widgets/Measure/MeasureViewModel.js 236

Returns:

true if the object has been destroyed, false otherwise.

reset()
Widgets/Measure/MeasureViewModel.js 226

Resets the widget.

toggleActive()
Widgets/Measure/MeasureViewModel.js 186

Toggles the state of the toolbar.

toggleInstructions()
Widgets/Measure/MeasureViewModel.js 193

Toggles the visibility of the instructions panel.