Class LineDrawing

LineDrawing – Concrete drawing class for creating and interacting with a 3D line (2 points) in a Cesium scene.

Extends Drawing for the specialized use case of drawing simple lines:

Allows placement/movement of precisely 2 points in 3D space
Visualizes the connection as a polylined Cesium entity with optional custom color
Manages visibility, cleanup, and interaction lifecycles

Param: app

The Cesium or host application instance/context.

Param: options

Param: options.cartesians

Array of initial Cartesian points.

Param: options.pointColor

Color applied to points.

Param: options.lineColor

Color for the line.

Param: options.addPoint

If true, entry begins with first point added.

Param: options.onMoveCallback

Callback on point movement.

Example

const line = new LineDrawing(viewer, {
  pointColor: Cesium.Color.RED,
  lineColor: Cesium.Color.DEEPPINK
});

// After user move/set/finish
console.log('Line points:', line.cartesians);

Hierarchy (View Summary)

Drawing
- LineDrawing

Index

Constructors

constructor

new LineDrawing(app: any, options?: object): LineDrawing
Create a new interactive line drawing instance.
Parameters
- app: any
  Main Cesium application or viewer.
- Optionaloptions: object = {}
  See class doc for keys.
Returns LineDrawing
Overrides Drawing.constructor
- Defined in src/Core/Drawing/LineDrawing.js:52

Properties

_lineColor

_lineColor: any

_pointColor

_pointColor: any

app

app: any

destroyed

destroyed: undefined | boolean

id

id: any

line

line: any

Cesium entity for the rendered polyline.

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
Main color for the polyline.

Returns Color
- Defined in src/Core/Drawing/LineDrawing.js:105
set lineColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/Core/Drawing/LineDrawing.js:108

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
Main color for the points.

Returns Color
- Defined in src/Core/Drawing/LineDrawing.js:123
set pointColor(value: Color): void
Parameters
- value: Color
Returns void
- Defined in src/Core/Drawing/LineDrawing.js:126

points

get points(): PointSet3D | PointEntity[]
Returns PointSet3D | PointEntity[]
- Defined in src/Core/Drawing/LineDrawing.js:143
set points(_: PointSet3D | PointEntity[]): void
The points in the drawing (including the current one if not finished). Setting the points array is a no-op.
Parameters
- _: PointSet3D | PointEntity[]
Returns void
- Defined in src/Core/Drawing/LineDrawing.js:138

show

get show(): boolean
Control visibility of points and the line.

Returns boolean
Overrides Drawing.show
- Defined in src/Core/Drawing/LineDrawing.js:93
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/LineDrawing.js:96

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
Remove all Cesium entities and clean up.

Returns null
Overrides Drawing.destroy
- Defined in src/Core/Drawing/LineDrawing.js:207

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 connection polyline in the scene, if not already created. Sets up live-updating Cesium entity with per-position updates.

Returns void
Method
- Defined in src/Core/Drawing/LineDrawing.js:154

terminate

terminate(): boolean
Finalize (lock-in) line only if both points are set.

Returns boolean
True if finish is allowed, false if not enough points.
Overrides Drawing.terminate
- Defined in src/Core/Drawing/LineDrawing.js:189

Class LineDrawing

Param: app

Param: options

Param: options.cartesians

Param: options.pointColor

Param: options.lineColor

Param: options.addPoint

Param: options.onMoveCallback

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LineDrawing

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

Returns void

Method