AreaMeasurement

new IonSdkMeasurements.AreaMeasurement(options)

Creates a polygonal area 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 area : Number
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 48

Gets the area value in meters squared

readonly icon : String
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 59

Gets the icon.

readonly id : String
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 99

Gets the id.

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

Gets the instruction text.

readonly thumbnail : String
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 68

Gets the thumbnail.

readonly type : String
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 77

Gets the type.

Methods

destroy()
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 152

Destroys the widget.

handleClick(clickPosition)
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 123

Handles click events while drawing a polygon.
Name Type Description
clickPosition Cartesian2 The click position

handleDoubleClick()
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 115

Ends drawing on double click.

handleMouseMove(mousePosition)
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 131

Handles mouse move events while drawing a polygon.
Name Type Description
mousePosition Cartesian2 The mouse position

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

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

reset()
packages/ion-sdk-measurements/Source/Measure/AreaMeasurement.js 138

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