Class PolylineMeasurement

PolylineMeasurement – Interactive tool for measuring the total length of a user-defined polyline in Cesium 3D scenes.

Extends Measurement and leverages PolylineDrawing for interactive placement and editing. Provides:

User editing of 2 or more (up to optional max) points defining a polyline
Live visualization and segment labeling (via child LineMeasurements)
Automatic summing of all segment distances and a dynamic label for total length
Show/hide and cleanup controls for full lifecycle management
Supports custom point/line color, units, max points, visibility toggle, etc.

Param: app

Cesium Viewer or application context.

Param: options

Param: options.cartesians

Initial points of the polyline.

Param: options.maxPoints

(Optional) Maximum number of vertices allowed.

Param: options.pointColor

Color of polyline points.

Param: options.lineColor

Color of the polyline.

Param: options.unit

Measurement unit for segment and total distances.

Param: options.render

Should geometry be drawn immediately.

Example

const polylineMeas = new PolylineMeasurement(viewer, {
  pointColor: Cesium.Color.BLUE,
  lineColor: Cesium.Color.RED,
  maxPoints: 10,
  render: true
});

// Get total measured length
console.log('Total polyline length:', polylineMeas.distance);

Hierarchy (View Summary)

Measurement
- PolylineMeasurement

Index

Constructors

constructor

new PolylineMeasurement(app: any, options?: object): PolylineMeasurement
Create a new PolylineMeasurement.
Parameters
- app: any
  Cesium Viewer or host application.
- Optionaloptions: object = {}
  See class doc for parameters.
Returns PolylineMeasurement
Overrides Measurement.constructor
- Defined in src/Core/Measurement/PolylineMeasurement.js:53

Properties

_cartesians

_cartesians: any

_finished

_finished: undefined | boolean

_unit

_unit: undefined | string

app

app: any

Reference to the parent Cesium Viewer or app.

destroyed

destroyed: undefined | boolean

drawing

drawing: undefined | PolylineDrawing

id

id: string

Unique identifier for this measurement instance.

label

label: Label

Label associated with this measurement (unit and prefix are forwarded).

lineColor

lineColor: Color

Polyline color.

onFinishCallback

onFinishCallback: Function

Finish callback (settable by onFinish()).

pointColor

pointColor: Color

Point marker color.

render

render: any

segments

segments: undefined | any[]

Accessors

cartesians

get cartesians(): any
Returns any
Inherited from Measurement.cartesians
- Defined in src/Core/Measurement/Measurement.js:108
set cartesians(value: any): void
Measurement points, as an array or CallbackProperty.
Parameters
- value: any
Returns void
Inherited from Measurement.cartesians
- Defined in src/Core/Measurement/Measurement.js:105

color

get color(): Color
Per-segment color (propagated to all LineMeasurements).

Returns Color
- Defined in src/Core/Measurement/PolylineMeasurement.js:133
set color(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/Core/Measurement/PolylineMeasurement.js:136

distance

get distance(): number
Total length of all polyline segments (sum of per-segment distances).

Returns number
- Defined in src/Core/Measurement/PolylineMeasurement.js:148

finished

get finished(): boolean
Completion/finished flag for lifecycle control.

Returns boolean
Inherited from Measurement.finished
- Defined in src/Core/Measurement/Measurement.js:119
set finished(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Measurement.finished
- Defined in src/Core/Measurement/Measurement.js:122

show

get show(): boolean
Determines full visibility of measurement objects.

Returns boolean
- Defined in src/Core/Measurement/PolylineMeasurement.js:117
set show(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/Core/Measurement/PolylineMeasurement.js:120

showLabel

get showLabel(): boolean
Determine if the label should be shown (at least 3 points, or 3 committed if rendered).

Returns boolean
- Defined in src/Core/Measurement/PolylineMeasurement.js:181

unit

get unit(): string
Measurement unit for calculations and display.

Returns string
Inherited from Measurement.unit
- Defined in src/Core/Measurement/Measurement.js:93
set unit(value: string): void
Parameters
- value: string
Returns void
Inherited from Measurement.unit
- Defined in src/Core/Measurement/Measurement.js:96

Methods

buildSegments

buildSegments(): void
Build or rebuild the internal segment LineMeasurements from the current polyline vertices. Removes and destroys old segments.

Returns void
- Defined in src/Core/Measurement/PolylineMeasurement.js:160

calculate

calculate(): number
Abstract calculation function. Subclasses MUST override.

Returns number
Calculated value (distance, area, etc.)

Throws
Not implemented (base class).
Inherited from Measurement.calculate
- Defined in src/Core/Measurement/Measurement.js:165

calculateCenter

calculateCenter(): undefined | number[]
Calculates the (geometric) center of all measurement points.

Returns undefined | number[]
Array [x, y, z] or undefined if no points.
Inherited from Measurement.calculateCenter
- Defined in src/Core/Measurement/Measurement.js:144

cancel

cancel(): boolean
Cancel and destroy all resources related to the measurement.

Returns boolean
- Defined in src/Core/Measurement/PolylineMeasurement.js:226

destroy

destroy(): null
Destroy all associated entities, drawings, and labels.

Returns null
Overrides Measurement.destroy
- Defined in src/Core/Measurement/PolylineMeasurement.js:238

finish

finish(): void
Trigger the onFinish callback explicitly.

Returns void
Method
Inherited from Measurement.finish
- Defined in src/Core/Measurement/Measurement.js:196

onFinish

onFinish(callback: (arg0: Measurement) => void): Measurement
Set a callback to fire when measurement is finished. Chainable.
Parameters
- callback: (arg0: Measurement) => void
Returns Measurement
Inherited from Measurement.onFinish
- Defined in src/Core/Measurement/Measurement.js:185

terminate

terminate(): boolean
Finalize measurement: only allowed if there are at least 2 segments. Sums up final segment measurement.

Returns boolean
True if finalized, false otherwise.
- Defined in src/Core/Measurement/PolylineMeasurement.js:204

updateLabel

updateLabel(): void
Update main label dynamically (center + full polyline length).

Returns void
Overrides Measurement.updateLabel
- Defined in src/Core/Measurement/PolylineMeasurement.js:190

Class PolylineMeasurement

Param: app

Param: options

Param: options.cartesians

Param: options.maxPoints

Param: options.pointColor

Param: options.lineColor

Param: options.unit

Param: options.render

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PolylineMeasurement

Properties

_cartesians

_finished

_unit

app

destroyed

drawing

id

label

lineColor

onFinishCallback

pointColor

render

segments

Accessors

cartesians

Returns any

Parameters

Returns void

color

Returns Color

Parameters

Returns void

distance

Returns number

finished

Returns boolean

Parameters

Returns void

show

Returns boolean

Parameters

Returns void

showLabel

Returns boolean

unit

Returns string

Parameters

Returns void

Methods

buildSegments

Returns void

calculate

Returns number

Throws

calculateCenter

Returns undefined | number[]

cancel

Returns boolean

destroy

Returns null

finish

Returns void

Method

onFinish

Parameters

Returns Measurement

terminate

Returns boolean

updateLabel