Class PanoramaMap

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

Hierarchy (view full)

VcsMap
- PanoramaMap

Index

Accessors

active

get active(): boolean
Whether the map is active or not

Returns boolean
Inherited from VcsMap.active
- Defined in src/map/vcsMap.ts:196

className

get className(): string
Returns string
Inherited from VcsMap.className
- Defined in src/vcsObject.ts:45

currentPanoramaImage

get currentPanoramaImage(): undefined | PanoramaImage
Returns undefined | PanoramaImage
- Defined in src/map/panoramaMap.ts:99

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
Inherited from VcsMap.layerCollection
- Defined in src/map/vcsMap.ts:257
set layerCollection(layerCollection): void
Parameters
- layerCollection: LayerCollection
Returns void
Inherited from VcsMap.layerCollection
- Defined in src/map/vcsMap.ts:264

loading

get loading(): boolean
Whether the map is loading or not

Returns boolean
Inherited from VcsMap.loading
- Defined in src/map/vcsMap.ts:203

movementApiCallsDisabled

get movementApiCallsDisabled(): boolean
Whether api calls like gotoViewpoint & setting of oblique images are disabled

Returns boolean
Inherited from VcsMap.movementApiCallsDisabled
- Defined in src/map/vcsMap.ts:238

movementDisabled

get movementDisabled(): boolean
Returns boolean
Deprecated
use disableMovement() for setting and movementApiCallsDisabled, movementKeyEventsDisabled and movementPointerEventsDisabled getter
Inherited from VcsMap.movementDisabled
- Defined in src/map/vcsMap.ts:225
set movementDisabled(prevent): void
Parameters
- prevent: boolean
Returns void
Inherited from VcsMap.movementDisabled
- Defined in src/map/vcsMap.ts:214

movementKeyEventsDisabled

get movementKeyEventsDisabled(): boolean
Whether movement related key events like the arrow keys for navigating in map are disabled.

Returns boolean
Inherited from VcsMap.movementKeyEventsDisabled
- Defined in src/map/vcsMap.ts:243

movementPointerEventsDisabled

get movementPointerEventsDisabled(): boolean
Whether movement related pointer events for navigating in map are disabled.

Returns boolean
Inherited from VcsMap.movementPointerEventsDisabled
- Defined in src/map/vcsMap.ts:248

panoramaCameraController

get panoramaCameraController(): PanoramaCameraController
The panorama camera controller controlling the camera movement. Throws if not properly initialized

Returns PanoramaCameraController
- Defined in src/map/panoramaMap.ts:118

panoramaView

get panoramaView(): PanoramaImageView
The panorama image view controlling image loading and rendering. Throws if not properly initialized

Returns PanoramaImageView
- Defined in src/map/panoramaMap.ts:107

postRender

get postRender(): VcsEvent<VcsMapRenderEvent<V>>
An event raised on the maps post render

Returns VcsEvent<VcsMapRenderEvent<V>>
Inherited from VcsMap.postRender
- Defined in src/map/vcsMap.ts:314

screenSpaceEventHandler

get screenSpaceEventHandler(): ScreenSpaceEventHandler
Internal API. throws if not properly initialized

Returns ScreenSpaceEventHandler
- Defined in src/map/panoramaMap.ts:92

splitPosition

get splitPosition(): number
Returns number
Inherited from VcsMap.splitPosition
- Defined in src/map/vcsMap.ts:295
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
Inherited from VcsMap.splitPosition
- Defined in src/map/vcsMap.ts:303

target

get target(): null | HTMLElement
The currently set HTML element in which to render the map

Returns null | HTMLElement
Inherited from VcsMap.target
- Defined in src/map/vcsMap.ts:210

`Static`className

get className(): string
Returns string
Overrides VcsMap.className
- Defined in src/map/panoramaMap.ts:43

Constructors

constructor

new PanoramaMap(options): PanoramaMap
Parameters
- options: PanoramaMapOptions
Returns PanoramaMap
Overrides VcsMap.constructor
- Defined in src/map/panoramaMap.ts:80

Methods

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>
Overrides VcsMap.activate
- Defined in src/map/panoramaMap.ts:190

addPrimitiveCollection

addPrimitiveCollection(primitiveCollection): void
Internal API used to register visualizations from layer implementations
Parameters
- primitiveCollection: PrimitiveCollection | Cesium3DTileset
Returns void
- Defined in src/map/panoramaMap.ts:350

addVisualization

addVisualization(item): void
Adds a visualization to the visualizations map for its layer. The visualization must be valid, use validateVisualization first
Parameters
- item: VisualisationType & {
  [vectorClusterGroupName]?: string;
  }
Returns void
Inherited from VcsMap.addVisualization
- Defined in src/map/vcsMap.ts:410

canShowViewpoint

canShowViewpoint(_viewpoint): Promise<boolean>
Determines whether this map can show this viewpoint. Returns true in any other map then ObliqueMap
Parameters
- _viewpoint: Viewpoint
Returns Promise<boolean>
Inherited from VcsMap.canShowViewpoint
- Defined in src/map/vcsMap.ts:352

deactivate

deactivate(): void
deactivates the map

Returns void
Overrides VcsMap.deactivate
- Defined in src/map/panoramaMap.ts:198

destroy

destroy(): void
disposes the map

Returns void
Overrides VcsMap.destroy
- Defined in src/map/panoramaMap.ts:398

disableMovement

disableMovement(prevent): void
prevent all movement, including api calls (gotoViewpoint, setting oblique images), key and pointer events.
Parameters
- prevent: boolean | DisableMapControlOptions
Returns void
Inherited from VcsMap.disableMovement
- Defined in src/map/vcsMap.ts:532

getCesiumWidget

getCesiumWidget(): CesiumWidget
Access to the raw cesium widget for finer control. Throws if not properly initialized.

Returns CesiumWidget
- Defined in src/map/panoramaMap.ts:128

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>
- Defined in src/map/panoramaMap.ts:273

getClosestImageFromViewpoint

getClosestImageFromViewpoint(viewpoint): Promise<undefined | PanoramaImage>
getClosestImage for the given viewpoint. Prefers the ground position
Parameters
- viewpoint: Viewpoint
Returns Promise<undefined | PanoramaImage>
- Defined in src/map/panoramaMap.ts:256

getCurrentResolution

getCurrentResolution(_coordinate): number
Resolution in meters per pixe
Parameters
- _coordinate: Coordinate
  coordinate in mercator for which to determine resolution. only required in 3D
Returns number
Inherited from VcsMap.getCurrentResolution
- Defined in src/map/vcsMap.ts:585

getLogger

getLogger(): Logger
Returns Logger
Inherited from VcsMap.getLogger
- Defined in src/vcsObject.ts:49

getViewpoint

getViewpoint(): Promise<null | Viewpoint>
Returns the most precise viewpoint possible in ObliqueMap.

Returns Promise<null | Viewpoint>
Overrides VcsMap.getViewpoint
- Defined in src/map/panoramaMap.ts:205

getViewpointSync

getViewpointSync(): null | Viewpoint
Returns an approximate viewpoint in ObliqueMap, not requesting terrain.

Returns null | Viewpoint
Overrides VcsMap.getViewpointSync
- Defined in src/map/panoramaMap.ts:209

getVisualizations

getVisualizations(): VisualisationType[]
Get all visualizations added to this map.

Returns VisualisationType[]
Inherited from VcsMap.getVisualizations
- Defined in src/map/vcsMap.ts:476

getVisualizationsForLayer

getVisualizationsForLayer(layer): undefined | Set<VisualisationType>
Gets the visualizations for a specific layer
Parameters
- layer: Layer<LayerImplementation<VcsMap<VisualisationType>>>
Returns undefined | Set<VisualisationType>
Inherited from VcsMap.getVisualizationsForLayer
- Defined in src/map/vcsMap.ts:460

getVisualizationsForVectorClusterGroup

getVisualizationsForVectorClusterGroup(group): undefined | Set<VisualisationType>
Gets the visualizations of a vector cluster group
Parameters
- group: VectorClusterGroup
Returns undefined | Set<VisualisationType>
Inherited from VcsMap.getVisualizationsForVectorClusterGroup
- Defined in src/map/vcsMap.ts:467

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
- viewpoint: Viewpoint
Returns Promise<void>
Overrides VcsMap.gotoViewpoint
- Defined in src/map/panoramaMap.ts:221

indexChanged

indexChanged(layer): void
is called if a layer changes its position in the layerCollection.
Parameters
- layer: Layer<LayerImplementation<VcsMap<VisualisationType>>>
Returns void
Overrides VcsMap.indexChanged
- Defined in src/map/panoramaMap.ts:331

initialize

initialize(): Promise<void>
Returns Promise<void>
Overrides VcsMap.initialize
- Defined in src/map/panoramaMap.ts:135

pointIsVisible

pointIsVisible(_coords): boolean
Parameters
- _coords: Coordinate
Returns boolean
Inherited from VcsMap.pointIsVisible
- Defined in src/map/vcsMap.ts:590

removePrimitiveCollection

removePrimitiveCollection(primitiveCollection): void
Internal API to unregister the visualization for a layers implementation
Parameters
- primitiveCollection: PrimitiveCollection | Cesium3DTileset
Returns void
- Defined in src/map/panoramaMap.ts:370

removeVisualization

removeVisualization(item): void
Removes a visualization
Parameters
- item: VisualisationType & {
  [vectorClusterGroupName]?: string;
  }
Returns void
Inherited from VcsMap.removeVisualization
- Defined in src/map/vcsMap.ts:436

requestRender

requestRender(): void
Requests this map to render when possible

Returns void
Inherited from VcsMap.requestRender
- Defined in src/map/vcsMap.ts:598

setCurrentImage

setCurrentImage(image?): void
Sets the current image to the given panorama image. If the image is undefined, the current image is cleared.
Parameters
- Optionalimage: PanoramaImage
Returns void
- Defined in src/map/panoramaMap.ts:322

setTarget

setTarget(target): void
Sets the map target.
Parameters
- target: null | string | HTMLElement
Returns void
Inherited from VcsMap.setTarget
- Defined in src/map/vcsMap.ts:359

toJSON

toJSON(): PanoramaMapOptions
Returns PanoramaMapOptions
Overrides VcsMap.toJSON
- Defined in src/map/panoramaMap.ts:377

validateVisualization

validateVisualization(item): item is VisualisationType & {
[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: VisualisationType
Returns item is VisualisationType & {
[vcsLayerName]?: string;
[vectorClusterGroupName]?: string;
}
Inherited from VcsMap.validateVisualization
- Defined in src/map/vcsMap.ts:388

`Static`getDefaultOptions

getDefaultOptions(): PanoramaMapOptions
Returns PanoramaMapOptions
Overrides VcsMap.getDefaultOptions
- Defined in src/map/panoramaMap.ts:47

Properties

`Optional`[moduleIdSymbol]

[moduleIdSymbol]?: string

`Readonly`currentImageChanged

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.

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

mapElement

mapElement: HTMLElement

movementDisabledChanged

movementDisabledChanged: VcsEvent<DisableMapControlOptions>

`Readonly`name

name: string

unique Name

pointerInteractionEvent

pointerInteractionEvent: VcsEvent<MapEvent>

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

properties

properties: Record<string, unknown>

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

Class PanoramaMap

Hierarchy (view full)

Index

Accessors

Constructors

Methods

Properties

Accessors

active

Returns boolean

className

Returns string

currentPanoramaImage

Returns undefined | PanoramaImage

layerCollection

Returns LayerCollection

Parameters

Returns void

loading

Returns boolean

movementApiCallsDisabled

Returns boolean

movementDisabled

Returns boolean

Deprecated

Parameters

Returns void

movementKeyEventsDisabled

Returns boolean

movementPointerEventsDisabled

Returns boolean

panoramaCameraController

Returns PanoramaCameraController

panoramaView

Returns PanoramaImageView

postRender

Returns VcsEvent<VcsMapRenderEvent<V>>

screenSpaceEventHandler

Returns ScreenSpaceEventHandler

splitPosition

Returns number

Parameters

Returns void

target

Returns null | HTMLElement

StaticclassName

Returns string

Constructors

constructor

Parameters

Returns PanoramaMap

Methods

activate

Returns Promise<void>

addPrimitiveCollection

Parameters

Returns void

addVisualization

Parameters

Returns void

canShowViewpoint

Parameters

Returns Promise<boolean>

deactivate

Returns void

destroy

Returns void

disableMovement

Parameters

Returns void

getCesiumWidget

Returns CesiumWidget

getClosestImage

Parameters

Returns Promise<undefined | PanoramaImage>

getClosestImageFromViewpoint

Parameters

Returns Promise<undefined | PanoramaImage>

getCurrentResolution

Parameters

`Static`className

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

`Static`getDefaultOptions

`Optional`[moduleIdSymbol]

`Readonly`currentImageChanged

`Readonly`name