Class CzmlLayer

Hierarchy (view full)

Accessors

  • get allowPicking(): boolean
  • Returns boolean

  • set allowPicking(allowPicking): void
  • Parameters

    • allowPicking: boolean

    Returns void

  • get className(): string
  • Returns string

  • get exclusive(): boolean
  • Indicates, that this layer is part of an exclusiveGroup

    Returns boolean

  • get exclusiveGroups(): (string | symbol)[]
  • An array of arbitrary exclusive groups

    Returns (string | symbol)[]

  • set exclusiveGroups(groups): void
  • Parameters

    • groups: (string | symbol)[]

    Returns void

  • get headers(): undefined | Record<string, string>
  • directly manipulating the headers Object will not trigger a reload. Reload the data via layer.reload() manually.

    Returns undefined | Record<string, string>

  • set headers(headers): void
  • Parameters

    • headers: undefined | Record<string, string>

    Returns void

  • get hiddenObjectIds(): string[]
  • Returns string[]

  • set hiddenObjectIds(hiddenObjectIds): void
  • Parameters

    • hiddenObjectIds: string[]

    Returns void

  • get initialized(): boolean
  • True if this layer has been initialized, typically after its first activation.

    Returns boolean

  • get locale(): string
  • returns the currently set locale. Can be used to provide locale specific URLs.

    Returns string

  • set locale(value): void
  • sets the locale and reloads the layer the if the URL is a locale aware Object.

    Parameters

    • value: string

    Returns void

  • get url(): string
  • A layers url, should on be configured, else an empty string

    Returns string

  • set url(url): void
  • Parameters

    • url: string | Record<string, string>

    Returns void

  • get zIndex(): number
  • Returns number

  • set zIndex(index): void
  • Parameters

    • index: number

    Returns void

Constructors

Methods

  • Activates this layer object, i.e. changes its internal view state and updates the map. The returned promise resolves, once the layer & any _implementations are initialized and all data is loaded. Once the promise resolves, the layer can still be inactive, if deactivate was called while initializing the layer.

    Returns Promise<void>

  • adds an entity

    Parameters

    • options: Entity | ConstructorOptions

      Cesium Entity options or the entity

    • Optionalattributes: Record<string, unknown>

      a set of properties, typically used for rendering a balloon

    • OptionalallowPicking: boolean

      whether to override the layers allowPicking setting for this entity

    Returns null | string

    the entities id

  • destroys all current implementations and recreates the ones which have an active map. called for instance when the URL for a layer changes

    Returns Promise<void>

  • is called from the map when the map is activated, and this layer is in the layerCollection of the map. Will create an implementation if it does not exits and will forward the activation call to the implementation.

    Parameters

    Returns Promise<void>

Properties

_headers?: Record<string, string>
_supportedMaps: string[] = ...

The class names of the supported maps.

_url: undefined | string | Record<string, string>
[moduleIdSymbol]?: string
activeOnStartup: boolean
clock: undefined | DataSourceClock = undefined
copyright: undefined | CopyrightOptions
datasourceId?: string

Optional Id to synchronize with the vcPublisher Datasources. This can also be used to track a connection to other sources of data.

entities: EntityCollection = ...

The entities of this layer. Use the addEntity API to add Enitities to ensure interoperability with vcm interfaces

exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>

event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument

extent: null | Extent
featureProvider: undefined | AbstractFeatureProvider

An optional feature provider to provider features based on click events.

featureVisibility: FeatureVisibility = ...

The feature visibility of this layer. NOTE: Entities cannot be highlighted at this moment.

isDestroyed: boolean
loaded: Promise<void> = ...

A Promise resolving with the DataSourceLayer on load

mapNames: string[]
name: string

unique Name

properties: Record<string, unknown>
sourceUri: undefined | string
stateChanged: VcsEvent<LayerState>

Event raised, if the layers state changes. Is passed the LayerState as its only parameter

zIndexChanged: VcsEvent<number>

Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.