HorizontalMeasurement

new IonSdkMeasurements.HorizontalMeasurement(options)

Draws a measurement between two points with the same height.
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
points PointPrimitiveCollection A collection for adding the point primitives
labels LabelCollection A collection for adding the labels
primitives PrimitiveCollection A collection for adding primitives

Members

readonly distance : Number
packages/ion-sdk-measurements/Source/Measure/HorizontalMeasurement.js 48

Gets the distance in meters

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

Gets the icon.

readonly id : String
packages/ion-sdk-measurements/Source/Measure/HorizontalMeasurement.js 101

Gets the id.

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

Gets the instruction text.

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

Gets the thumbnail.

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

Gets the type.

Methods

destroy()
packages/ion-sdk-measurements/Source/Measure/HorizontalMeasurement.js 167

Destroys the measurement.

handleClick(clickPosition)
packages/ion-sdk-measurements/Source/Measure/HorizontalMeasurement.js 125

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

handleDoubleClick()
packages/ion-sdk-measurements/Source/Measure/HorizontalMeasurement.js 117

Ends drawing on double click.

handleMouseMove(mousePosition, shift)
packages/ion-sdk-measurements/Source/Measure/HorizontalMeasurement.js 138

Handles mouse movements while drawing a horizontal measurement.
Name Type Description
mousePosition Cartesian2 The mouse position
shift Boolean True if the shift key was pressed

isDestroyed() → Boolean
packages/ion-sdk-measurements/Source/Measure/HorizontalMeasurement.js 160

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

reset()
packages/ion-sdk-measurements/Source/Measure/HorizontalMeasurement.js 153

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