Class BaseCesiumMap

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

Hierarchy (view full)

VcsMap<CesiumVisualisationType>
- BaseCesiumMap
  - CesiumMap
  - PanoramaMap

Index

Accessors

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

Constructors

constructor

Accessors

active

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

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

className

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

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

layerTypes

get layerTypes(): string[]
Returns string[]
Inherited from VcsMap.layerTypes
- Defined in src/map/vcsMap.ts:330
set layerTypes(types): void
The types of layers to display on this map. An empty array means all types.
Parameters
- types: string[]
Returns void
Inherited from VcsMap.layerTypes
- Defined in src/map/vcsMap.ts:338

loading

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

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

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:250

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:237
set movementDisabled(prevent): void
Parameters
- prevent: boolean
Returns void
Inherited from VcsMap.movementDisabled
- Defined in src/map/vcsMap.ts:226

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:255

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:260

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:326

splitPosition

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

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:222

terrainProvider

get terrainProvider(): undefined | null | TerrainProvider
Returns undefined | null | TerrainProvider
- Defined in src/map/baseCesiumMap.ts:161

`Static`className

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

Constructors

constructor

new BaseCesiumMap(options): BaseCesiumMap
Parameters
- options: VcsMapOptions
Returns BaseCesiumMap
Inherited from VcsMap.constructor
- Defined in src/map/vcsMap.ts:158

Methods

`Protected`_indexChangedOnVisualization

_indexChangedOnVisualization(vis): void
Parameters
- vis: CesiumVisualisationType
Returns void
- Defined in src/map/baseCesiumMap.ts:438

`Protected`_initializeCesiumWidget

_initializeCesiumWidget(widget): void
Parameters
- widget: CesiumWidget
Returns void
- Defined in src/map/baseCesiumMap.ts:165

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/baseCesiumMap.ts:198

addImageryLayer

addImageryLayer(imageryLayer): void
Internal API used to register visualizations from layer implementations
Parameters
- imageryLayer: ImageryLayer
Returns void
- Defined in src/map/baseCesiumMap.ts:499

addPrimitiveCollection

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

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
Inherited from VcsMap.addVisualization
- Defined in src/map/vcsMap.ts:442

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:384

deactivate

deactivate(): void
deactivates the map

Returns void
Overrides VcsMap.deactivate
- Defined in src/map/baseCesiumMap.ts:206

destroy

destroy(): void
disposes the map

Returns void
Overrides VcsMap.destroy
- Defined in src/map/baseCesiumMap.ts:558

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:564

getCesiumWidget

getCesiumWidget(): null | CesiumWidget
returns the cesium Widget Object

Returns null | CesiumWidget
- Defined in src/map/baseCesiumMap.ts:427

getCurrentResolution

getCurrentResolution(coordinate): number
Resolution in meters per pixe
Parameters
- coordinate: Coordinate
Returns number
Overrides VcsMap.getCurrentResolution
- Defined in src/map/baseCesiumMap.ts:278

getCurrentResolutionFromCartesian

getCurrentResolutionFromCartesian(cartesian): number
Parameters
- cartesian: Cartesian3
Returns number
- Defined in src/map/baseCesiumMap.ts:291

getLogger

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

getScene

getScene(): undefined | Scene
returns the cesium Scene Object, returns null on non initialized or destroyed maps

Returns undefined | Scene
- Defined in src/map/baseCesiumMap.ts:434

getViewpoint

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

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

getViewpointSync

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

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

getVisualizations

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

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

getVisualizationsForLayer

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

getVisualizationsForVectorClusterGroup

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

gotoViewpoint

gotoViewpoint(_viewpoint, _optMaximumHeight?): Promise<void>
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>
Inherited from VcsMap.gotoViewpoint
- Defined in src/map/vcsMap.ts:587

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/baseCesiumMap.ts:454

initialize

initialize(): Promise<void>
Returns Promise<void>
Inherited from VcsMap.initialize
- Defined in src/map/vcsMap.ts:406

pointIsVisible

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

removeImageryLayer

removeImageryLayer(imageryLayer): void
Internal API used to unregister visualizations from layer implementations
Parameters
- imageryLayer: ImageryLayer
Returns void
- Defined in src/map/baseCesiumMap.ts:516

removePrimitiveCollection

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

removeVisualization

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

requestRender

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

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

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:391

setTerrainProvider

setTerrainProvider(terrainProvider): void
set the cesium TerrainProvider
Parameters
- terrainProvider: TerrainProvider
Returns void
- Defined in src/map/baseCesiumMap.ts:524

toJSON

toJSON(defaultOptions?): VcsMapOptions
Parameters
- defaultOptions: VcsMapOptions = ...
Returns VcsMapOptions
Inherited from VcsMap.toJSON
- Defined in src/map/vcsMap.ts:632

unsetTerrainProvider

unsetTerrainProvider(terrainProvider): void
unsets the TerrainProvider (changes to the default TerrainProvider if the given terranProvider is currently active)
Parameters
- terrainProvider: TerrainProvider
Returns void
- Defined in src/map/baseCesiumMap.ts:533

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;
}
Inherited from VcsMap.validateVisualization
- Defined in src/map/vcsMap.ts:420

`Static`getDefaultOptions

getDefaultOptions(): VcsMapOptions
Returns VcsMapOptions
Inherited from VcsMap.getDefaultOptions
- Defined in src/map/vcsMap.ts:71

Properties

`Protected`_cesiumWidget

_cesiumWidget: null | CesiumWidget = null

`Protected`_listeners

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

`Protected`_terrainProvider

_terrainProvider: undefined | null | TerrainProvider = null

`Optional`[moduleIdSymbol]

[moduleIdSymbol]?: string

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

`Readonly`layerTypesChanged

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

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>

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

Class BaseCesiumMap

Hierarchy (view full)

Index

Accessors

Constructors

Methods

Properties

Accessors

active

Returns boolean

className

Returns string

layerCollection

Returns LayerCollection

Parameters

Returns void

layerTypes

Returns string[]

Parameters

Returns void

loading

Returns boolean

movementApiCallsDisabled

Returns boolean

movementDisabled

Returns boolean

Deprecated

Parameters

Returns void

movementKeyEventsDisabled

Returns boolean

movementPointerEventsDisabled

Returns boolean

postRender

Returns VcsEvent<VcsMapRenderEvent<V>>

splitPosition

Returns number

Parameters

Returns void

target

Returns null | HTMLElement

terrainProvider

Returns undefined | null | TerrainProvider

StaticclassName

Returns string

Constructors

constructor

Parameters

Returns BaseCesiumMap

Methods

Protected_indexChangedOnVisualization

Parameters

Returns void

Protected_initializeCesiumWidget

Parameters

Returns void

activate

Returns Promise<void>

addImageryLayer

Parameters

Returns 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 null | CesiumWidget

getCurrentResolution

`Static`className

`Protected`_indexChangedOnVisualization

`Protected`_initializeCesiumWidget

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

`Static`getDefaultOptions

`Protected`_cesiumWidget

`Protected`_listeners

`Protected`_terrainProvider

`Optional`[moduleIdSymbol]