Class PolygonDrawing

PolygonDrawing – Interactive drawing class for creating filled polygons in Cesium scenes.

Extends Drawing to support:

User placement of 3 or more points (with an optional maximum)
Live rendering of both the polyline outline and the polygon area fill as Cesium entities
Color controls for outline and area
Interactive show/hide, update, and cleanup of all involved entities

Param: app

The Cesium Viewer or host application context.

Param: options

Param: options.points

Optional initial point array (vertices).

Param: options.maxPoints

Maximum points/vertices allowed (optional).

Param: options.color

Fill color for points/polygon.

Param: options.addPoint

Start with first point placed.

Param: options.onMoveCallback

Fired when a vertex is moved.

Example

const poly = new PolygonDrawing(viewer, {
  color: Cesium.Color.CYAN.withAlpha(0.3),
  maxPoints: 5
});

// After user finished
console.log('Polygon coordinates:', poly.cartesians);

Hierarchy (View Summary)

Drawing
- PolygonDrawing

Index

Constructors

constructor

new PolygonDrawing(
    app: any,
    options?: {
        addPoint?: boolean;
        color?: any;
        maxPoints?: number;
        onMoveCallback?: Function;
        points?: Cartesian3[];
    },
): PolygonDrawing
Constructor for a PolygonDrawing instance.
Parameters
- app: any
  Cesium viewer or scene host.
- Optionaloptions: {
      addPoint?: boolean;
      color?: any;
      maxPoints?: number;
      onMoveCallback?: Function;
      points?: Cartesian3[];
  } = {}
  - OptionaladdPoint?: boolean
    Start with one point.
  - Optionalcolor?: any
    Polygon fill and point color.
  - OptionalmaxPoints?: number
    (Optional) max number of polygon vertices.
  - OptionalonMoveCallback?: Function
    Callback for vertex move.
  - Optionalpoints?: Cartesian3[]
    Initial array of Cartesian3 points.
Returns PolygonDrawing
Overrides Drawing.constructor
- Defined in src/Core/Drawing/PolygonDrawing.js:59

Properties

app

app: any

destroyed

destroyed: undefined | boolean

id

id: any

line

line: any

Cesium polyline entity for polygon outline.

onFinishCallback

onFinishCallback: any

onMoveCallback

onMoveCallback: any

onSetCallback

onSetCallback: any

point

point: undefined | PointEntity

pointSet

pointSet: PointSet3D

polygon

polygon: any

Cesium polygon entity for area fill.

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
Primary polygon color (applies to both area and outline).

Returns Color
Overrides Drawing.color
- Defined in src/Core/Drawing/PolygonDrawing.js:108
set color(value: Color): void
The color applied to the points.
Parameters
- value: Color
Returns void
Overrides Drawing.color
- Defined in src/Core/Drawing/PolygonDrawing.js:111

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

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

points

get points(): PointSet3D | PointEntity[]
Returns PointSet3D | PointEntity[]
- Defined in src/Core/Drawing/PolygonDrawing.js:129
set points(_: PointSet3D | PointEntity[]): void
Current vertex set (does not allow external replacement).
Parameters
- _: PointSet3D | PointEntity[]
Returns void
- Defined in src/Core/Drawing/PolygonDrawing.js:125

show

get show(): boolean
Show/hide all related entities (points, line, area).

Returns boolean
Overrides Drawing.show
- Defined in src/Core/Drawing/PolygonDrawing.js:95
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/PolygonDrawing.js:98

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 point, outline, and area entities from the Cesium viewer.

Returns null
Overrides Drawing.destroy
- Defined in src/Core/Drawing/PolygonDrawing.js:227

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 dynamic outline (closed polyline) and area (polygon) in the scene. Creates entities only once; positions are kept reactive with CallbackProperty.

Returns void
Method
- Defined in src/Core/Drawing/PolygonDrawing.js:140

terminate

terminate(): boolean
Finalize the polygon only if it has at least 3 vertices. Handles cases for unlimited points (deletes last temp), and sets finished=true.

Returns boolean
True if polygon is valid (3+ points), false otherwise.
Overrides Drawing.terminate
- Defined in src/Core/Drawing/PolygonDrawing.js:199

Class PolygonDrawing

Param: app

Param: options

Param: options.points

Param: options.maxPoints

Param: options.color

Param: options.addPoint

Param: options.onMoveCallback

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionaladdPoint?: boolean

Optionalcolor?: any

OptionalmaxPoints?: number

OptionalonMoveCallback?: Function

Optionalpoints?: Cartesian3[]

Returns PolygonDrawing

Properties

app

destroyed

id

line

onFinishCallback

onMoveCallback

onSetCallback

point

pointSet

polygon

Accessors

cartesians

Returns Cartesian3[]

Parameters

Returns void

color

Returns Color

Parameters

Returns void

finished

Returns boolean

Parameters

Returns void

maxPoints

Returns number

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

terminate

Returns boolean

Settings

On This Page

`Optional`addPoint?: boolean

`Optional`color?: any

`Optional`maxPoints?: number

`Optional`onMoveCallback?: Function

`Optional`points?: Cartesian3[]