@vcmap/core
    Preparing search index...

    Class BaseCesiumMap

    Map Base Class, each different map is derived from this abstract base class.

    Hierarchy (View Summary)

    Index

    Accessors

    active className layerCollection layerTypes loading movementApiCallsDisabled movementDisabled movementKeyEventsDisabled movementPointerEventsDisabled postRender preloadAncestors splitPosition target terrainProvider className

    Constructors

    constructor

    Methods

    _indexChangedOnVisualization _initializeCesiumWidget activate addImageryLayer addPrimitiveCollection addVisualization canShowViewpoint deactivate destroy disableMovement getCesiumWidget getCurrentResolution getCurrentResolutionFromCartesian getLogger getScene getViewpoint getViewpointSync getVisualizations getVisualizationsForLayer getVisualizationsForVectorClusterGroup gotoViewpoint indexChanged initialize pointIsVisible removeImageryLayer removePrimitiveCollection removeVisualization requestRender setPreloadAncestors setTarget setTerrainProvider toJSON unsetTerrainProvider validateVisualization getDefaultOptions

    Properties

    _cesiumWidget _listeners _terrainProvider [moduleIdSymbol]? defaultTerrainProvider destroyLayerCollection fallbackMap fallbackToCurrentMap initialized isDestroyed layerTypesChanged mapElement movementDisabledChanged name pointerInteractionEvent properties screenSpaceEventHandler stateChanged visualizationAdded visualizationRemoved

    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 splitPosition(): number

      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

    Constructors

    Methods

    Protected_indexChangedOnVisualization

    • _indexChangedOnVisualization(vis: CesiumVisualisationType): void

      Parameters

      • vis: CesiumVisualisationType

      Returns void

    Protected_initializeCesiumWidget

    • 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>

    • Internal API used to register visualizations from layer implementations

      Parameters

      • imageryLayer: ImageryLayer

      Returns 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

    • Parameters

      • cartesian: Cartesian3

      Returns number

    • returns the cesium Scene Object, returns null on non initialized or destroyed maps

      Returns Scene | undefined

    • sets the view to the given viewpoint

      Parameters

      • _viewpoint: Viewpoint
      • Optional_optMaximumHeight: number

        during animation (can be used to get rid of the bunny hop) gotoViewpoint

      Returns Promise<void>

    • Internal API used to unregister visualizations from layer implementations

      Parameters

      • imageryLayer: ImageryLayer

      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

    • defines whether ancestors are preloaded or not

      Parameters

      • value: boolean

      Returns void

    • Sets the map target.

      Parameters

      • target: string | HTMLElement | null

      Returns void

    • set the cesium TerrainProvider

      Parameters

      • terrainProvider: TerrainProvider

      Returns void

    • Parameters

      • defaultOptions: BaseCesiumMapOptions = ...

      Returns BaseCesiumMapOptions

    • 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

    Protected_cesiumWidget

    _cesiumWidget: CesiumWidget | null = null

    Protected_listeners

    _listeners: (() => void)[] = []

    Protected_terrainProvider

    _terrainProvider: TerrainProvider | null | undefined = null
    "[moduleIdSymbol]"?: string
    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.

    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

    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
    stateChanged: VcsEvent<MapState>

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

    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

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods
    Properties