Measurement

new IonSdkMeasurements.Measurement(options)

An abstract class defining a measurement.
Name Type Description
options Object An object with the following properties:
Name Type 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
primitives PrimitiveCollection A collection in which to store the measurement primitives
labels LabelCollection A collection in which to add the labels
points PointPrimitiveCollection A collection in which to add points

Members

readonly icon : String
packages/ion-sdk-measurements/Source/Measure/Measurement.js 44

Gets the icon.

readonly id : String
packages/ion-sdk-measurements/Source/Measure/Measurement.js 80

Gets the id.

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

Gets the instruction text.

selectedUnits : String
packages/ion-sdk-measurements/Source/Measure/Measurement.js 89

Gets selected units.

readonly thumbnail : String
packages/ion-sdk-measurements/Source/Measure/Measurement.js 53

Gets the thumbnail.

readonly type : String
packages/ion-sdk-measurements/Source/Measure/Measurement.js 62

Gets the type.

Methods

destroy()
packages/ion-sdk-measurements/Source/Measure/Measurement.js 153

Destroys the widget.

handleClick(clickPosition)
packages/ion-sdk-measurements/Source/Measure/Measurement.js 116

Handles click events while performing a measurement.
Name Type Description
clickPosition Cartesian2 The click position

handleDoubleClick()
packages/ion-sdk-measurements/Source/Measure/Measurement.js 110

Handles double click events while performing a measurement.

handleLeftDown(mousePosition)
packages/ion-sdk-measurements/Source/Measure/Measurement.js 128

Handles left down mouse events while performing a measurement.
Name Type Description
mousePosition Cartesian2 The mouse position

handleLeftUp(mousePosition)
packages/ion-sdk-measurements/Source/Measure/Measurement.js 134

Handles left up mouse events while performing a measurement.
Name Type Description
mousePosition Cartesian2 The mouse position

handleMouseMove(mousePosition)
packages/ion-sdk-measurements/Source/Measure/Measurement.js 122

Handles mouse move events while performing a measurement.
Name Type Description
mousePosition Cartesian2 The mouse position

isDestroyed() → Boolean
packages/ion-sdk-measurements/Source/Measure/Measurement.js 145

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

reset()
packages/ion-sdk-measurements/Source/Measure/Measurement.js 140

Resets the widget.
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