@vcmap/core
    Preparing search index...

    Class CesiumMap

    Cesium Globe Map Class (3D map)

    Hierarchy (View Summary)

    Index

    Accessors

    Constructors

    Methods

    Properties

    Accessors

    • get active(): boolean

      Whether the map is active or not

      Returns boolean

    • get className(): string

      Returns string

    • get layerCollection(): LayerCollection

      The layer collection of this map. LayerCollections can be shared among maps. When adding the map to a , the layer collection of the will be set. When setting the layer collection, the destroyLayerCollection flag is automatically set to false.

      Returns LayerCollection

    • set layerCollection(layerCollection: LayerCollection): void

      Parameters

      Returns void

    • get layerTypes(): string[]

      Returns string[]

    • set layerTypes(types: string[]): void

      The types of layers to display on this map. An empty array means all types.

      Parameters

      • types: string[]

      Returns void

    • get loading(): boolean

      Whether the map is loading or not

      Returns boolean

    • get movementApiCallsDisabled(): boolean

      Whether api calls like gotoViewpoint & setting of oblique images are disabled

      Returns boolean

    • get movementDisabled(): boolean

      Returns boolean

      use disableMovement() for setting and movementApiCallsDisabled, movementKeyEventsDisabled and movementPointerEventsDisabled getter

    • set movementDisabled(prevent: boolean): void

      Parameters

      • prevent: boolean

      Returns void

    • get movementKeyEventsDisabled(): boolean

      Whether movement related key events like the arrow keys for navigating in map are disabled.

      Returns boolean

    • get movementPointerEventsDisabled(): boolean

      Whether movement related pointer events for navigating in map are disabled.

      Returns boolean

    • get preloadAncestors(): boolean

      Returns boolean

    • set preloadAncestors(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get splitPosition(): number

      The splitPosition should always be aligned with the mapCollection's splitPosition. Use mapCollection to change splitPosition.

      Returns number

    • set splitPosition(position: number): void

      The splitPosition should always be aligned with the mapCollection's splitPosition. Use mapCollection to change splitPosition.

      Parameters

      • position: number

      Returns void

    • get target(): HTMLElement | null

      The currently set HTML element in which to render the map

      Returns HTMLElement | null

    • get terrainProvider(): TerrainProvider | null | undefined

      Returns TerrainProvider | null | undefined

    Constructors

    Methods

    • activates the map, if necessary initializes the map. Once the promise resolves, the map can still be inactive, if deactivate was called while the map was activating.

      Returns Promise<void>

    • Parameters

      • dataSource: CustomDataSource

      Returns Promise<void>

    • Internal API used to register visualizations from layer implementations

      Parameters

      • dataSource: CustomDataSource

      Returns Promise<void>

    • Internal API used to register visualizations from layer implementations

      Parameters

      • primitiveCollection: PrimitiveCollection | Cesium3DTileset | I3SDataProvider

      Returns void

    • Adds a visualization to the visualizations map for its layer. The visualization must be valid, use validateVisualization first

      Parameters

      • item: CesiumVisualisationType & { "[vectorClusterGroupName]"?: string }

      Returns void

    • prevent all movement, including api calls (gotoViewpoint, setting oblique images), key and pointer events.

      Parameters

      • prevent: boolean | DisableMapControlOptions

      Returns void

    • Returns the cluster dataSourceDisplays dataSources. This datasource can only handle Entities with Billboards, Labels or Points.

      Returns DataSourceCollection

    • returns the cesium DataSourceDisplay Object

      Returns DataSourceDisplay | null

    • returns the dataSourceCollection associated with the scene

      Returns DataSourceCollection | undefined

    • returns the Entities Collection

      Returns EntityCollection | undefined

    • getHeight for coordinates

      Parameters

      • positions: Coordinate[]

        in web mercator

      Returns Promise<Coordinate[]>

      the array of coordinates with heights updated in place

    • returns true if the WEBGL Extension EXT_frag_depth is supported. (Is used for GroundPoloygons)

      Returns boolean

    • returns true if the WEBGL Extension WEBGL_depth_texture is supported. (Is used for picking)

      Returns boolean

    • Parameters

      • dataSource: CustomDataSource

      Returns void

    • Internal API used to unregister visualizations from layer implementations

      Parameters

      • dataSource: CustomDataSource

      Returns void

    • Internal API to unregister the visualization for a layers implementation

      Parameters

      • primitiveCollection: PrimitiveCollection | Cesium3DTileset | I3SDataProvider

      Returns void

    • Removes a visualization

      Parameters

      • item: CesiumVisualisationType & { "[vectorClusterGroupName]"?: string }

      Returns void

    • set dataSource clock as display clock to visualize time dependent animation

      Parameters

      • clock: DataSourceClock

      Returns void

    • sets the position of the sun according to the day

      Parameters

      • julianDate: JulianDate

        See the Cesium API

      Returns void

    • sets the lighting of the globe with the sun as a light source

      Parameters

      • value: boolean

      Returns void

    • Sets a shadow map on the scene of the cesiumMaps cesiumWidget. Raises an event if the shadow map changes. This function should be used to set the shadowMap instead of setting it directly on the scene.

      Parameters

      • shadowMap: ShadowMap

        The shadowMap to assign to the scene of the cesium widget.

      Returns void

    • unset dataSource clock

      Parameters

      • clock: DataSourceClock

      Returns void

    • unsets the TerrainProvider (changes to the default TerrainProvider if the given terranProvider is currently active)

      Parameters

      • terrainProvider: TerrainProvider

      Returns void

    • Validates a visualization. A visualization must have the vcsLayeName symbol set and a layer with said name must be part of the maps layerCollection.

      Parameters

      • item: CesiumVisualisationType

      Returns item is CesiumVisualisationType & {
          "[vcsLayerName]"?: string;
          "[vectorClusterGroupName]"?: string;
      }

    Properties

    _cesiumWidget: CesiumWidget | null = null
    _listeners: (() => void)[] = []
    _terrainProvider: TerrainProvider | null | undefined = null
    "[moduleIdSymbol]"?: string
    dataSourceDisplay: DataSourceDisplay | null = null
    dataSourceDisplayClock: Clock

    clock for animated data

    defaultJDate: JulianDate
    defaultTerrainProvider: TerrainProvider | null = null
    destroyLayerCollection: boolean

    Whether to destroy the layerCollection when destroying the map. Defaults to false if passing in a LayerCollection and true if a LayerCollection is created. Is set to false, when setting a different LayerCollection.

    enableLightning: boolean
    fallbackMap: string | null

    The name of a map to fall back on, if this map cant show a viewpoint

    fallbackToCurrentMap: boolean

    instead of using a fallback map, this map will fail to activate if another map is active and the current viewpoint cannot be shown

    globeColor: Color
    initialized: boolean
    isDestroyed: boolean
    layerTypesChanged: VcsEvent<string[]> = ...
    mapElement: HTMLElement
    movementDisabledChanged: VcsEvent<DisableMapControlOptions>
    name: string

    unique Name

    pointerInteractionEvent: VcsEvent<MapEvent>

    Event raised then the map has a pointer interaction. Raises MapEvent.

    properties: Record<string, unknown>
    screenSpaceEventHandler: ScreenSpaceEventHandler | null = null
    shadowMapChanged: VcsEvent<ShadowMap> = ...
    stateChanged: VcsEvent<MapState>

    Event raised when the maps state changes. Is passed the MapState as its only argument.

    tileCacheSize: number
    useOriginalCesiumShader: boolean
    visualizationAdded: VcsEvent<VisualisationType>

    Event raised when a visualization is added to the map

    visualizationRemoved: VcsEvent<VisualisationType>

    Event raised when a visualization is removed from the map

    webGLaa: boolean