Class SurfaceHighlight

A flyweight implementation for highlighting 2D surface objects in Cesium.

This class provides highlighting for ground-clamped geometries (polygons, polylines, rectangles)

Supported Geometry Types:

Entity with polygon, polyline, or rectangle graphics
GroundPrimitive instances

Highlighting Modes:

Fill mode (default): Creates a filled geometry using the original shape
Outline mode: Creates a polyline outline of the original geometry

Example

// Basic usage
const viewer = new Viewer('cesiumContainer');
const surfaceHighlight = new SurfaceHighlight(viewer);

// Highlight an entity with default red fill
const entity = viewer.entities.add(new Entity({
  polygon: {
    hierarchy: Cartesian3.fromDegreesArray([-75, 35, -74, 35, -74, 36, -75, 36]),
    material: Color.BLUE
  }
}));
surfaceHighlight.show(entity);

Implements

Highlight.Base

Index

Constructors

constructor

new SurfaceHighlight(viewer: Viewer): SurfaceHighlight
Creates a new SurfaceHighlight instance.
Parameters
- viewer: Viewer
  A viewer to create highlight entity in
Returns SurfaceHighlight
- Defined in highlight/surface-highlight.ts:59

Properties

`Private`_color

_color: Color = Color.RED

`Private`_currentObject

_currentObject: undefined | Entity | GroundPrimitive

`Private`_currentOptions

_currentOptions: undefined | Options

`Private`_entities

_entities: EntityCollection

`Private`_entity

_entity: Entity

Accessors

color

get color(): Color
Gets the highlight color.

Returns Color
Implementation of Base.color
- Defined in highlight/surface-highlight.ts:336
set color(color: Color): void
Sets the highlight color.
Parameters
- color: Color
Returns void
Implementation of Base.color
- Defined in highlight/surface-highlight.ts:341

currentObject

get currentObject(): undefined | Entity | GroundPrimitive
Gets the currently highlighted object

Returns undefined | Entity | GroundPrimitive
- Defined in highlight/surface-highlight.ts:351

entity

get entity(): Entity
Gets the highlight entity

Returns Entity
- Defined in highlight/surface-highlight.ts:346

Methods

`Private`_clearGeometries

_clearGeometries(): void
Private
Removes all geometry properties from the highlight entity

Returns void
- Defined in highlight/surface-highlight.ts:151

`Private`_optionsEqual

_optionsEqual(
options1: undefined | Options,
options2: undefined | Options,
): boolean
Private
Compares two Highlight.Options objects for equality
Parameters
- options1: undefined | Options
- options2: undefined | Options
Returns boolean
- Defined in highlight/surface-highlight.ts:129

`Private`_update

_update(from: Entity, options?: Options): void
Private
Updates the highlight entity from an Entity object
Parameters
- from: Entity
- Optionaloptions: Options
Returns void
- Defined in highlight/surface-highlight.ts:161
_update(from: GroundPrimitive, options?: Options): void
Private
Updates the highlight entity from a GroundPrimitive
Parameters
- from: GroundPrimitive
- Optionaloptions: Options
Returns void
- Defined in highlight/surface-highlight.ts:166

destroy

destroy(): void
Clean up the instances

Returns void
Implementation of Base.destroy
- Defined in highlight/surface-highlight.ts:327

hide

hide(): void
Clears the current highlight

Returns void
Implementation of Base.hide
- Defined in highlight/surface-highlight.ts:317

show

show(object: Entity | GroundPrimitive, options?: Options): undefined | Entity
Highlights a picked object by updating the reusable entity
Parameters
- object: Entity | GroundPrimitive
  The object to be highlighted.
- Optionaloptions: Options
  Optional style for the highlight.
Returns undefined | Entity
See
Highlight.Options
Implementation of Base.show
- Defined in highlight/surface-highlight.ts:77

Class SurfaceHighlight

Example

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SurfaceHighlight

Properties

Private_color

Private_currentObject

Private_currentOptions

Private_entities

Private_entity

Accessors

color

Returns Color

Parameters

Returns void

currentObject

Returns undefined | Entity | GroundPrimitive

entity

Returns Entity

Methods

Private_clearGeometries

Returns void

Private_optionsEqual

Parameters

Returns boolean

Private_update

Parameters

Returns void

Parameters

Returns void

destroy

Returns void

hide

Returns void

show

Parameters

Returns undefined | Entity

See

Settings

On This Page

`Private`_color

`Private`_currentObject

`Private`_currentOptions

`Private`_entities

`Private`_entity

`Private`_clearGeometries

`Private`_optionsEqual

`Private`_update