Class PanoramaMap

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

Hierarchy (view full)

Accessors

active className currentPanoramaImage defaultFov layerCollection layerTypes loading movementApiCallsDisabled movementDisabled movementKeyEventsDisabled movementPointerEventsDisabled panoramaCameraController panoramaView postRender splitPosition target terrainProvider className

Constructors

constructor

Methods

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

Properties

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

Accessors

active

  • get active(): boolean

  • Whether the map is active or not

    Returns boolean

className

  • get className(): string

  • Returns string

currentPanoramaImage

defaultFov

layerCollection

  • 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): void

  • Parameters

    Returns void

layerTypes

  • get layerTypes(): string[]

  • Returns string[]

  • set layerTypes(types): void

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

    Parameters

    • types: string[]

    Returns void

loading

  • get loading(): boolean

  • Whether the map is loading or not

    Returns boolean

movementApiCallsDisabled

  • get movementApiCallsDisabled(): boolean

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

    Returns boolean

movementDisabled

  • get movementDisabled(): boolean

  • Returns boolean

    Deprecated

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

  • set movementDisabled(prevent): void

  • Parameters

    • prevent: boolean

    Returns void

movementKeyEventsDisabled

  • get movementKeyEventsDisabled(): boolean

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

    Returns boolean

movementPointerEventsDisabled

  • get movementPointerEventsDisabled(): boolean

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

    Returns boolean

panoramaCameraController

panoramaView

postRender

splitPosition

  • get splitPosition(): number

  • Returns number

  • set splitPosition(position): void

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

    Parameters

    • position: number

    Returns void

target

  • get target(): null | HTMLElement

  • The currently set HTML element in which to render the map

    Returns null | HTMLElement

terrainProvider

  • get terrainProvider(): undefined | null | TerrainProvider

  • Returns undefined | null | TerrainProvider

StaticclassName

Constructors

constructor

Methods

Protected_indexChangedOnVisualization

Protected_initializeCesiumWidget

activate

  • activate(): Promise<void>

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

addImageryLayer

addPrimitiveCollection

addVisualization

  • addVisualization(item): 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

canShowViewpoint

deactivate

destroy

disableMovement

  • disableMovement(prevent): void

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

    Parameters

    • prevent: boolean | DisableMapControlOptions

    Returns void

getCesiumWidget

getClosestImage

  • getClosestImage(coordinate, maxDistance?): Promise<undefined | PanoramaImage>

  • Returns the closest image to the given coordinate within the given distance from all the datasets in the panorama datasets collection.

    Parameters

    • coordinate: Coordinate
    • maxDistance: number = 200

    Returns Promise<undefined | PanoramaImage>

getClosestImageFromViewpoint

getCurrentResolution

getCurrentResolutionFromCartesian

getLogger

getScene

getViewpoint

getViewpointSync

getVisualizations

getVisualizationsForLayer

getVisualizationsForVectorClusterGroup

gotoViewpoint

  • gotoViewpoint(viewpoint): Promise<void>

  • Sets the current image to the closest image to the given coordinate. Unsets the current image, if there is no image within the default distance.

    Parameters

    Returns Promise<void>

indexChanged

initialize

pointIsVisible

removeImageryLayer

removePrimitiveCollection

removeVisualization

requestRender

setCurrentImage

  • setCurrentImage(image?): void

  • Sets the current image to the given panorama image. If the image is undefined, the current image is cleared.

    Parameters

    Returns void

setTarget

setTerrainProvider

toJSON

unsetTerrainProvider

validateVisualization

  • validateVisualization(item): item is CesiumVisualisationType & {
        [vcsLayerName]?: string;
        [vectorClusterGroupName]?: string;
    }

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

StaticgetDefaultOptions

Properties

Protected_cesiumWidget

_cesiumWidget: null | CesiumWidget = null

Protected_listeners

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

Protected_terrainProvider

_terrainProvider: undefined | null | TerrainProvider = null

Optional[moduleIdSymbol]

[moduleIdSymbol]?: string

ReadonlycurrentImageChanged

currentImageChanged: VcsEvent<undefined | PanoramaImage> = ...

The event raised when the current image changes. Can be raised with undefined if the current image is cleared or a viewpoint fails to load an image.

defaultTerrainProvider

defaultTerrainProvider: null | TerrainProvider = null

destroyLayerCollection

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

fallbackMap: null | string

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

fallbackToCurrentMap

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

initialized: boolean

isDestroyed

isDestroyed: boolean

ReadonlylayerTypesChanged

layerTypesChanged: VcsEvent<string[]> = ...

mapElement

mapElement: HTMLElement

movementDisabledChanged

movementDisabledChanged: VcsEvent<DisableMapControlOptions>

Readonlyname

name: string

unique Name

pointerInteractionEvent

pointerInteractionEvent: VcsEvent<MapEvent>

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

properties

properties: Record<string, unknown>

screenSpaceEventHandler

screenSpaceEventHandler: null | ScreenSpaceEventHandler = null

stateChanged

stateChanged: VcsEvent<MapState>

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

visualizationAdded

visualizationAdded: VcsEvent<VisualisationType>

Event raised when a visualization is added to the map

visualizationRemoved

visualizationRemoved: VcsEvent<VisualisationType>

Event raised when a visualization is removed from the map

Settings

Member Visibility

On This Page

Accessors
Constructors
Methods
Properties