Class PolylineDrawing

PolylineDrawing – Interactive drawing class for creating polylines (multi-segment lines) in Cesium scenes.

Extends Drawing to support:

User placement of at least two, up to an optional maximum number of points
Live rendering of a polyline Cesium entity connecting all points in order
Properties for controlling color, visibility, and dynamic point operations
All necessary cleanup and lifecycle management for editing workflows

Param: app

The Cesium Viewer or application context.

Param: options

Param: options.points

Optional initial list of points.

Param: options.maxPoints

(Optional) maximum allowed vertices.

Param: options.pointColor

Color for the interactive points.

Param: options.lineColor

Color for the polyline.

Param: options.addPoint

Start with the first point added.

Param: options.onMoveCallback

Fired when a point is moved.

Param: options.onSetCallback

Fired when a point is set.

Example

const polyline = new PolylineDrawing(viewer, {
  maxPoints: 6,
  lineColor: Cesium.Color.YELLOW,
  pointColor: Cesium.Color.RED
});

// Listen for user-finished actions or updates, then:
console.log('Polyline geometry:', polyline.cartesians);

Hierarchy (View Summary)

Drawing
- PolylineDrawing

Index

Constructors

constructor

new PolylineDrawing(app: any, options?: object): PolylineDrawing
Parameters
- app: any
  Cesium Viewer or scene context.
- Optionaloptions: object = {}
  See above for details.
Returns PolylineDrawing
Overrides Drawing.constructor
- Defined in src/Core/Drawing/PolylineDrawing.js:55

Properties

_lineColor

_lineColor: any

_pointColor

_pointColor: any

app

app: any

destroyed

destroyed: undefined | boolean

id

id: any

line

line: any

Cesium polyline entity for this drawing.

onFinishCallback

onFinishCallback: any

onMoveCallback

onMoveCallback: any

onSetCallback

onSetCallback: any

point

point: undefined | PointEntity

pointSet

pointSet: PointSet3D

Accessors

cartesians

get cartesians(): Cartesian3[]
Access the current array of point positions.

Returns Cartesian3[]
Inherited from Drawing.cartesians
- Defined in src/Core/Drawing/Drawing.js:91
set cartesians(value: Cartesian3[]): void
Parameters
- value: Cartesian3[]
Returns void
Inherited from Drawing.cartesians
- Defined in src/Core/Drawing/Drawing.js:94

color

get color(): Color
The color applied to the points.

Returns Color
Inherited from Drawing.color
- Defined in src/Core/Drawing/Drawing.js:102
set color(value: Color): void
Parameters
- value: Color
Returns void
Inherited from Drawing.color
- Defined in src/Core/Drawing/Drawing.js:105

finished

get finished(): boolean
Indicates if drawing is finished.

Returns boolean
Inherited from Drawing.finished
- Defined in src/Core/Drawing/Drawing.js:126
set finished(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Drawing.finished
- Defined in src/Core/Drawing/Drawing.js:129

lineColor

get lineColor(): Color
Polyline color (updates entity material).

Returns Color
- Defined in src/Core/Drawing/PolylineDrawing.js:118
set lineColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/Core/Drawing/PolylineDrawing.js:121

maxPoints

get maxPoints(): number
The maximum number of points.

Returns number
Inherited from Drawing.maxPoints
- Defined in src/Core/Drawing/Drawing.js:138
set maxPoints(value: number): void
Parameters
- value: number
Returns void
Inherited from Drawing.maxPoints
- Defined in src/Core/Drawing/Drawing.js:141

pointColor

get pointColor(): Color
Point color (updates pointSet).

Returns Color
- Defined in src/Core/Drawing/PolylineDrawing.js:136
set pointColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/Core/Drawing/PolylineDrawing.js:139

points

get points(): PointSet3D | PointEntity[]
Returns PointSet3D | PointEntity[]
- Defined in src/Core/Drawing/PolylineDrawing.js:154
set points(_: PointSet3D | PointEntity[]): void
All points in the polyline. Setter is a no-op (for Drawing API consistency).
Parameters
- _: PointSet3D | PointEntity[]
Returns void
- Defined in src/Core/Drawing/PolylineDrawing.js:150

show

get show(): boolean
Change visibility of both points and connected line.

Returns boolean
Overrides Drawing.show
- Defined in src/Core/Drawing/PolylineDrawing.js:106
set show(value: boolean): void
Visibility of the drawing (true = points shown).
Parameters
- value: boolean
Returns void
Overrides Drawing.show
- Defined in src/Core/Drawing/PolylineDrawing.js:109

Methods

addPoint

addPoint(): void
Add another interactive 3D point to the drawing. Triggers relevant callbacks when placement is complete or limit is reached.

Returns void
Method
Inherited from Drawing.addPoint
- Defined in src/Core/Drawing/Drawing.js:151

cancel

cancel(): boolean
Cancel this drawing (destroys if not already finished).

Returns boolean
True if canceled, false if already finished.
Inherited from Drawing.cancel
- Defined in src/Core/Drawing/Drawing.js:187

destroy

destroy(): null
Destroy all created entities and remove from Cesium scene.

Returns null
Overrides Drawing.destroy
- Defined in src/Core/Drawing/PolylineDrawing.js:224

finish

finish(): void
Manually trigger the finish callback.

Returns void
Inherited from Drawing.finish
- Defined in src/Core/Drawing/Drawing.js:223

onFinish

onFinish(callback: (arg0: Drawing) => void): Drawing
Register a callback for when the drawing is finished. Chainable: returns this.
Parameters
- callback: (arg0: Drawing) => void
  Called when drawing is finished.
Returns Drawing
Inherited from Drawing.onFinish
- Defined in src/Core/Drawing/Drawing.js:213

render

render(): void
Render the Cesium polyline entity, creating it only once. Entity positions are kept reactive through CallbackProperty.

Returns void
Method
- Defined in src/Core/Drawing/PolylineDrawing.js:165

terminate

terminate(): boolean
Complete the drawing only if two or more points are placed. For open-ended drawings, will remove the unfinished point.

Returns boolean
true if the polyline is valid/finished, else false.
Overrides Drawing.terminate
- Defined in src/Core/Drawing/PolylineDrawing.js:201

Class PolylineDrawing

Param: app

Param: options

Param: options.points

Param: options.maxPoints

Param: options.pointColor

Param: options.lineColor

Param: options.addPoint

Param: options.onMoveCallback

Param: options.onSetCallback

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PolylineDrawing

Properties

_lineColor

_pointColor

app

destroyed

id

line

onFinishCallback

onMoveCallback

onSetCallback

point

pointSet

Accessors

cartesians

Returns Cartesian3[]

Parameters

Returns void

color

Returns Color

Parameters

Returns void

finished

Returns boolean

Parameters

Returns void

lineColor

Returns Color

Parameters

Returns void

maxPoints

Returns number

Parameters

Returns void

pointColor

Returns Color

Parameters

Returns void

points

Returns PointSet3D | PointEntity[]

Parameters

Returns void

show

Returns boolean

Parameters

Returns void

Methods

addPoint

Returns void

Method

cancel

Returns boolean

destroy

Returns null

finish

Returns void

onFinish

Parameters

Returns Drawing

render