DistanceMeasurement

SWVL new Cesium.DistanceMeasurement(options)

Draws a measurement between two points.

Name Type Description

options

Object

An object with the following properties:

Name	Type	Default	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
`showComponentLines`	Boolean	`false`	optional Whether or not to show the x and y component lines

Members

readonly angleFromHorizontal : Number
Widgets/Measure/DistanceMeasurement.js 232

Gets the angle between horizontal and the distance line in radians

readonly angleFromVertical : Number
Widgets/Measure/DistanceMeasurement.js 243

Gets the angle between vertical and the distance line in radians

readonly distance : Number
Widgets/Measure/DistanceMeasurement.js 199

Gets the distance of the measurement in meters

readonly horizontalDistance : Number
Widgets/Measure/DistanceMeasurement.js 210

Gets the horizontal component of distance of the measurement in meters

readonly icon : String
Widgets/Measure/DistanceMeasurement.js 254

Gets the icon.

readonly id : String
Widgets/Measure/DistanceMeasurement.js 308

Gets the id.

readonly instructions : Array.<String>
Widgets/Measure/DistanceMeasurement.js 296

Gets the instruction text.

showComponentLines : Boolean
Widgets/Measure/DistanceMeasurement.js 322

Gets and sets whether or not to show the x and y component lines of the measurement.

Default Value: false

readonly thumbnail : String
Widgets/Measure/DistanceMeasurement.js 268

Gets the thumbnail.

readonly type : String
Widgets/Measure/DistanceMeasurement.js 282

Gets the type.

readonly verticalDistance : Number
Widgets/Measure/DistanceMeasurement.js 221

Gets the vertical component of the distance of the measurement in meters

Methods

destroy()
Widgets/Measure/DistanceMeasurement.js 670

Destroys the measurement.

handleClick(clickPosition)
Widgets/Measure/DistanceMeasurement.js 561

Handles click events while drawing a distance measurement.

Name	Type	Description
`clickPosition`	Cartesian2	The click position

handleMouseMove(mousePosition)
Widgets/Measure/DistanceMeasurement.js 601

Handles mouse move events while drawing a distance measurement.

Name	Type	Description
`mousePosition`	Cartesian2	The mouse position

isDestroyed() → Boolean
Widgets/Measure/DistanceMeasurement.js 663

Returns:

true if the object has been destroyed, false otherwise.

reset()
Widgets/Measure/DistanceMeasurement.js 641

Resets the measurement.