Class Layer

Layer – Unified wrapper for a wide variety of Cesium scene layers (3D tiles, meshes, imagery, terrain, geojson, etc).

Encapsulates both configuration and runtime state, custom shaders/styling/visibility, and offers utility methods for feature/content/visibility management, tagging, and hierarchy. Layer types can be easily checked via Layer.LayerTypes (B3DM, POINTS, MESH, etc).

Param: viewer

Cesium Viewer instance.

Param: options

Param: options.id

Unique ID (auto-generated if not provided).

Param: options.name

Display name for UI and legends.

Param: options.type

One of Layer.LayerTypes, stringly-typed.

Param: options.tags

Tags for grouping and filtering.

Param: options.content

The Cesium primitive/entity/object managed by this layer.

Param: options.url

Source or configuration URL.

Param: options.show

Initial visibility state.

Param: options.deletable

Can this layer be removed by the user?

Param: options.parent

Parent/collection this layer belongs to.

Param: options.imageryIndex

(Imagery) Layer index/hierarchy, if used.

Param: options.customShader

Custom shader for Cesium rendering (if set).

Param: options.style

Style configuration object for displayed features.

Param: options.maximumScreenSpaceError

Tiling/detail threshold.

Param: options.dynamicScreenSpaceError

Whether adaptive error is enabled.

Param: options.dynamicScreenSpaceErrorDensity

Param: options.dynamicScreenSpaceErrorFactor

Param: options.dynamicScreenSpaceErrorHeightFalloff

Param: options.styleManager

Optional reference for managing thematic styling/feature visibility.

Param: options.onShowChange

Callback for when 'show' value changes.

Method

addContent(content) - Add/merge a content primitive or object.

Method

removeContent() - Remove its Cesium scene primitive/data source/imagery layer.

Method

toggleVisibility(show, ids) - Show/hide if id matches (for bulk ops).

Method

toggleAllVisibilityExcept(show, excludeIds) - Show/hide unless excluded by id.

Static

Example

const meshLayer = new Layer(viewer, {type: Layer.LayerTypes.MESH, content: meshData, show: true});
meshLayer.show = false;
meshLayer.customShader = myShader;
meshLayer.tags.push("building");

Hierarchy (View Summary)

Layer
- LayerCollection
- ParticleSystemLayer

Constructors

constructor

new Layer(
    viewer: any,
    options?: {
        content?: any;
        customShader?: CustomShader;
        deletable?: boolean;
        dynamicScreenSpaceError?: boolean;
        dynamicScreenSpaceErrorDensity?: number;
        dynamicScreenSpaceErrorFactor?: number;
        dynamicScreenSpaceErrorHeightFalloff?: number;
        id?: string;
        imageryIndex?: null | number;
        maximumScreenSpaceError?: number;
        name?: string;
        onShowChange?: (arg0: boolean) => void;
        parent?: null | Layer;
        show?: boolean;
        style?: any;
        styleManager?: any;
        tags?: string | string[];
        type?: null | string;
        url?: string;
    },
): Layer
Parameters
- viewer: any
  The active Cesium Viewer instance.
- Optionaloptions: {
      content?: any;
      customShader?: CustomShader;
      deletable?: boolean;
      dynamicScreenSpaceError?: boolean;
      dynamicScreenSpaceErrorDensity?: number;
      dynamicScreenSpaceErrorFactor?: number;
      dynamicScreenSpaceErrorHeightFalloff?: number;
      id?: string;
      imageryIndex?: null | number;
      maximumScreenSpaceError?: number;
      name?: string;
      onShowChange?: (arg0: boolean) => void;
      parent?: null | Layer;
      show?: boolean;
      style?: any;
      styleManager?: any;
      tags?: string | string[];
      type?: null | string;
      url?: string;
  } = {}
  - Optionalcontent?: any
    Cesium primitive/entity/data/imagery/etc. managed by this layer.
  - OptionalcustomShader?: CustomShader
    Custom shader override for rendering.
  - Optionaldeletable?: boolean
    If false, prevents user from deleting/removing this layer.
  - OptionaldynamicScreenSpaceError?: boolean
    Enable adaptive (distance-based) detail for tiles.
  - OptionaldynamicScreenSpaceErrorDensity?: number
    Density parameter for adaptive LOD.
  - OptionaldynamicScreenSpaceErrorFactor?: number
    Factor parameter for adaptive LOD.
  - OptionaldynamicScreenSpaceErrorHeightFalloff?: number
    Height falloff for LOD optimization.
  - Optionalid?: string
    Unique layer ID (uuid generated if omitted).
  - OptionalimageryIndex?: null | number
    Optional imagery stacking/render order.
  - OptionalmaximumScreenSpaceError?: number
    Max error for LOD/tiling.
  - Optionalname?: string
    Human-readable display name (optional).
  - OptionalonShowChange?: (arg0: boolean) => void
    Callback, triggered whenever layer.visible ('show') changes.
  - Optionalparent?: null | Layer
    Parent/aggregate layer (if any).
  - Optionalshow?: boolean
    Initial visible state.
  - Optionalstyle?: any
    Style/appearance configuration for features/primitives/etc.
  - OptionalstyleManager?: any
    Style manager/controller (handles coloring/visibility in groups).
  - Optionaltags?: string | string[]
    Tags for grouping, styling, filtering layers.
  - Optionaltype?: null | string
    Layer type (see Layer.LayerTypes).
  - Optionalurl?: string
    Data source or config source URL.
Returns Layer
Example
```
const terrainLayer = new Layer(viewer, {
  name: 'Digital Terrain',
  type: Layer.LayerTypes.TERRAIN,
  url: 'https://myserver/DEM',
  show: true
});

terrainLayer.show = false; // hides layer
terrainLayer.customShader = myShader;
```
- Defined in src/Core/Layer.js:146

Properties

_clippingPolygons

_clippingPolygons: any

_customShader

_customShader: CustomShader

_dynamicScreenSpaceError

_dynamicScreenSpaceError: boolean

_dynamicScreenSpaceErrorDensity

_dynamicScreenSpaceErrorDensity: number

_dynamicScreenSpaceErrorFactor

_dynamicScreenSpaceErrorFactor: number

_dynamicScreenSpaceErrorHeightFalloff

_dynamicScreenSpaceErrorHeightFalloff: number

_maximumScreenSpaceError

_maximumScreenSpaceError: number

_opaque

_opaque: boolean

_parent

_parent: null | Layer

_show

_show: boolean

_style

_style: any

content

content: any

Cesium primitive/entity/imagery/terrain object.

deletable

deletable: boolean

Is the layer removable?

id

id: string

Unique ID for this layer.

imageryIndex

imageryIndex: null | number

name

name: string

Display/UI name.

onShowChange

onShowChange: (arg0: boolean) => void

originalShader

originalShader: CustomShader

originalTranslucencyMode

originalTranslucencyMode: any

resolved

resolved: boolean

styleManager

styleManager: any

type

type: null | string

Layer type (matches Layer.LayerTypes string values).

url

url: string

Configuration/source URL.

viewer

viewer: any

`Static`LayerTypes

LayerTypes: {
    B3DM: string;
    BASELAYER: string;
    COLLECTION: string;
    FEATURE: string;
    GEOJSON: string;
    GEOJSON3D: string;
    GLTF: string;
    IMAGERY: string;
    MESH: string;
    PARTICLE_SYSTEM: string;
    POINTS: string;
    TERRAIN: string;
} = ...

Enum of string layer types (B3DM, POINTS, ...).

Accessors

boundingSphere

get boundingSphere(): undefined | BoundingSphere
Returns the bounding sphere of the layer, for spatial queries and UI zoom-to-fit. The implementation is type-dependent:
- For tile/mesh/point clouds: directly returns content.boundingSphere.
- For (Geo)JSON: computes bounding sphere from all polygon and polyline points.
- For imagery: computes from imagery rectangle.
- For terrain/default: returns undefined.
Returns undefined | BoundingSphere
The bounding sphere, or undefined if not computable.
- Defined in src/Core/Layer.js:488

clippingPolygons

get clippingPolygons(): any
Get or set clipping polygons for this layer (used in 3D terrain/model clipping). Setter will propagate to the underlying Cesium content.

Returns any
- Defined in src/Core/Layer.js:349
set clippingPolygons(value: any): void
Parameters
- value: any
Returns void
- Defined in src/Core/Layer.js:353

color

set color(c: Color): void
Set the global color for all grouped features (handled externally). For mesh types, this may be handled elsewhere.
Parameters
- c: Color
Returns void
- Defined in src/Core/Layer.js:381

customShader

get customShader(): null | CustomShader
Returns null | CustomShader
- Current assigned CustomShader, if any.
- Defined in src/Core/Layer.js:339
set customShader(cs: null | CustomShader): void
Assigns a new custom shader to this layer (or disables if falsy). For non-GEOJSON layer types, handles full reconstruction (with translucency mode handling). For GEOJSON and GEOJSON3D, directly updates polygon or polyline material alpha.
Parameters
- cs: null | CustomShader
  Shader instance or null to disable.
Returns void
- Defined in src/Core/Layer.js:281

dynamicScreenSpaceError

get dynamicScreenSpaceError(): boolean
Returns boolean
- Defined in src/Core/Layer.js:411
set dynamicScreenSpaceError(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/Core/Layer.js:415

dynamicScreenSpaceErrorDensity

get dynamicScreenSpaceErrorDensity(): number
Returns number
- Defined in src/Core/Layer.js:420
set dynamicScreenSpaceErrorDensity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/Core/Layer.js:424

dynamicScreenSpaceErrorFactor

get dynamicScreenSpaceErrorFactor(): number
Returns number
- Defined in src/Core/Layer.js:429
set dynamicScreenSpaceErrorFactor(value: number): void
Parameters
- value: number
Returns void
- Defined in src/Core/Layer.js:433

dynamicScreenSpaceErrorHeightFalloff

get dynamicScreenSpaceErrorHeightFalloff(): number
Returns number
- Defined in src/Core/Layer.js:438
set dynamicScreenSpaceErrorHeightFalloff(value: number): void
Parameters
- value: number
Returns void
- Defined in src/Core/Layer.js:442

maximumScreenSpaceError

get maximumScreenSpaceError(): number
Returns number
- Defined in src/Core/Layer.js:402
set maximumScreenSpaceError(value: number): void
Parameters
- value: number
Returns void
- Defined in src/Core/Layer.js:406

opaque

get opaque(): boolean
Whether this layer is currently set as opaque. Triggers shader/mode update when changed.

Returns boolean
- Defined in src/Core/Layer.js:364
set opaque(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/Core/Layer.js:368

parent

get parent(): null | Layer
Returns null | Layer
- Current parent assigned, or null.
- Defined in src/Core/Layer.js:270
set parent(p: null | Layer): void
Sets or gets the parent collection/group layer (if present). Use to build hierarchies or nested layer collections.
Parameters
- p: null | Layer
  Parent layer to assign.
Returns void
- Defined in src/Core/Layer.js:263

show

get show(): boolean
Returns boolean
- Returns current "show" state.
- Defined in src/Core/Layer.js:253
set show(v: boolean): void
Show or hide this Layer. Deeply propagates the visible state to underlying Cesium content. If the layer is of type FEATURE, it also updates the style manager’s feature visibility and hideIDs. Triggers the onShowChange callback.
Parameters
- v: boolean
  True to show, false to hide.
Returns void
- Defined in src/Core/Layer.js:233

style

get style(): any
Returns any
- Defined in src/Core/Layer.js:398
set style(s: any): void
Sets or retrieves styling for the layer (e.g. for GeoJSON/tiles/features). For mesh types, style setting is usually not allowed.
Parameters
- s: any
  Style object.
Returns void
- Defined in src/Core/Layer.js:392

Methods

[iterator]

"[iterator]"(): Layer
Iterator protocol implementation for Layer. For Layer collections/objects, allows use in for...of loops. Always returns the Layer instance itself (not a collection).

Returns Layer
- Defined in src/Core/Layer.js:221

addContent

addContent(content: Layer): void
Sets the content of this Layer, and assigns this layer as its parent. Will throw if content is not a Layer.
Parameters
- content: Layer
  The Layer to add as content.
Returns void
Throws
If content is not a valid Layer.
- Defined in src/Core/Layer.js:463

getContent

getContent(): any
Returns the current "content" object assigned to this layer.

Returns any
The Cesium or sublayer content object.
- Defined in src/Core/Layer.js:475

getContentByTags

getContentByTags(tags: string[]): null | Layer
Returns this Layer if any of its tags are in the provided tags array.
Parameters
- tags: string[]
  Tags to check against.
Returns null | Layer
- Defined in src/Core/Layer.js:613

getContentByType

getContentByType(type: string): null | Layer
Returns this Layer if its type matches the given type, else null. Typically used for gathering/iterating matching content.
Parameters
- type: string
  Type string to check.
Returns null | Layer
- Defined in src/Core/Layer.js:595

getIdsByTags

getIdsByTags(tags: string[]): null | string
Returns this layer's ID if any of its tags are in the provided tags array.
Parameters
- tags: string[]
  Tags to check against.
Returns null | string
ID if a tag matches, else null.
- Defined in src/Core/Layer.js:604

getIdsByType

getIdsByType(type: string): null | string
Returns this layer's ID if its type matches the given type, else null.
Parameters
- type: string
  Type string to check.
Returns null | string
ID if match, else null.
- Defined in src/Core/Layer.js:585

getLayerById

getLayerById(): Layer
Returns this layer instance (used for lookup patterns in layer registries).

Returns Layer
- Defined in src/Core/Layer.js:565

isValidLayer

isValidLayer(layer: any): boolean
Checks if a given object is a valid Layer: Must be truthy, have an 'id' property, and be an actual Layer instance.
Parameters
- layer: any
  The object to check.
Returns boolean
True if the object is a valid Layer instance.
- Defined in src/Core/Layer.js:453

removeContent

removeContent(): void
Removes the Cesium primitive/entity/etc. for this layer from the scene and severs parent links. Handles resource de-allocation by layer type (removes primitive, data source, imagery, or terrain).

Returns void
- Defined in src/Core/Layer.js:530

removeLayer

removeLayer(layer: Layer): void
Removes a layer (and its content), unlinks its parent, and disables its content link. Used for structured layer collections.
Parameters
- layer: Layer
  The layer instance to remove.
Returns void
- Defined in src/Core/Layer.js:574

toggleAllVisibilityExcept

toggleAllVisibilityExcept(show: boolean, excludeIds: string[]): void
Shows the layer unless its ID or its content's UUID is present in the excludeIds array, otherwise hides it. Useful for toggling all layers except given ones.
Parameters
- show: boolean
- excludeIds: string[]
Returns void
- Defined in src/Core/Layer.js:635

toggleVisibility

toggleVisibility(show: boolean, layerIds: string | string[]): void
Shows/hides the Layer if its ID is in layerIds (or if layerIds unspecified). Batch operation interface for toggling by ID sets.
Parameters
- show: boolean
  Target visible state.
- layerIds: string | string[]
  ID or array of IDs to show/hide.
Returns void
- Defined in src/Core/Layer.js:623

Class Layer

Param: viewer

Param: options

Param: options.id

Param: options.name

Param: options.type

Param: options.tags

Param: options.content

Param: options.url

Param: options.show

Param: options.deletable

Param: options.parent

Param: options.imageryIndex

Param: options.customShader

Param: options.style

Param: options.maximumScreenSpaceError

Param: options.dynamicScreenSpaceError

Param: options.dynamicScreenSpaceErrorDensity

Param: options.dynamicScreenSpaceErrorFactor

Param: options.dynamicScreenSpaceErrorHeightFalloff

Param: options.styleManager

Param: options.onShowChange

Method

Method

Method

Method

Static

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optionalcontent?: any

OptionalcustomShader?: CustomShader

Optionaldeletable?: boolean

OptionaldynamicScreenSpaceError?: boolean

OptionaldynamicScreenSpaceErrorDensity?: number

OptionaldynamicScreenSpaceErrorFactor?: number

OptionaldynamicScreenSpaceErrorHeightFalloff?: number

Optionalid?: string

OptionalimageryIndex?: null | number

OptionalmaximumScreenSpaceError?: number

Optionalname?: string

OptionalonShowChange?: (arg0: boolean) => void

Optionalparent?: null | Layer

Optionalshow?: boolean

Optionalstyle?: any

OptionalstyleManager?: any

Optionaltags?: string | string[]

Optionaltype?: null | string

Optionalurl?: string

Returns Layer

Example

Properties

_clippingPolygons

_customShader

_dynamicScreenSpaceError

_dynamicScreenSpaceErrorDensity

_dynamicScreenSpaceErrorFactor

_dynamicScreenSpaceErrorHeightFalloff

_maximumScreenSpaceError

_opaque

_parent

_show

_style

content

deletable

id

imageryIndex

name

onShowChange

originalShader

originalTranslucencyMode

resolved

styleManager

`Optional`content?: any

`Optional`customShader?: CustomShader

`Optional`deletable?: boolean

`Optional`dynamicScreenSpaceError?: boolean

`Optional`dynamicScreenSpaceErrorDensity?: number

`Optional`dynamicScreenSpaceErrorFactor?: number

`Optional`dynamicScreenSpaceErrorHeightFalloff?: number

`Optional`id?: string

`Optional`imageryIndex?: null | number

`Optional`maximumScreenSpaceError?: number

`Optional`name?: string

`Optional`onShowChange?: (arg0: boolean) => void

`Optional`parent?: null | Layer

`Optional`show?: boolean

`Optional`style?: any

`Optional`styleManager?: any

`Optional`tags?: string | string[]

`Optional`type?: null | string

`Optional`url?: string

`Static`LayerTypes