Class CesiumMap

Cesium Globe Map Class (3D map)

Hierarchy (view full)

VcsMap<CesiumVisualisationType>
- CesiumMap

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

cameraLimiter

get cameraLimiter(): null | CameraLimiter
A camera limit to not allow the camera to get too close to the globe.

Returns null | CameraLimiter
- Defined in src/map/cesiumMap.ts:501
set cameraLimiter(limiter): void
Parameters
- limiter: null | CameraLimiter
Returns void
- Defined in src/map/cesiumMap.ts:505

className

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

defaultShadowMap

get defaultShadowMap(): null | ShadowMap
Returns null | ShadowMap
- Defined in src/map/cesiumMap.ts:490

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

lightIntensity

get lightIntensity(): number
returns the light Intensity, see Cesium https://cesium.com/learn/cesiumjs/ref-doc/SunLight.html?classFilter=sunlight#intensity

Returns number
- Defined in src/map/cesiumMap.ts:465
set lightIntensity(intensity): void
sets the light Intensity, see Cesium https://cesium.com/learn/cesiumjs/ref-doc/SunLight.html?classFilter=sunlight#intensity
Parameters
- intensity: number
Returns void
- Defined in src/map/cesiumMap.ts:472

loading

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

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

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

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

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

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

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

splitPosition

get splitPosition(): number
The splitPosition should always be aligned with the mapCollection's splitPosition. Use mapCollection to change splitPosition.

Returns number
Overrides VcsMap.splitPosition
- Defined in src/map/cesiumMap.ts:479
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
Overrides VcsMap.splitPosition
- Defined in src/map/cesiumMap.ts:483

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

terrainProvider

get terrainProvider(): null | TerrainProvider
Returns null | TerrainProvider
- Defined in src/map/cesiumMap.ts:494

`Static`className

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

Constructors

constructor

new CesiumMap(options): CesiumMap
Parameters
- options: CesiumMapOptions
Returns CesiumMap
Overrides VcsMap.constructor
- Defined in src/map/cesiumMap.ts:388

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/cesiumMap.ts:792

addClusterDataSource

addClusterDataSource(dataSource): Promise<void>
Parameters
- dataSource: CustomDataSource
Returns Promise<void>
- Defined in src/map/cesiumMap.ts:1300

addDataSource

addDataSource(dataSource): Promise<void>
Internal API used to register visualizations from layer implementations
Parameters
- dataSource: CustomDataSource
Returns Promise<void>
- Defined in src/map/cesiumMap.ts:1272

addImageryLayer

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

addPrimitiveCollection

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

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

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

deactivate

deactivate(): void
deactivates the map

Returns void
Overrides VcsMap.deactivate
- Defined in src/map/cesiumMap.ts:800

destroy

destroy(): void
disposes the map

Returns void
Overrides VcsMap.destroy
- Defined in src/map/cesiumMap.ts:1461

disableMovement

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

getCesiumWidget

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

Returns null | CesiumWidget
- Defined in src/map/cesiumMap.ts:1122

getClusterDatasources

getClusterDatasources(): DataSourceCollection
Returns the cluster dataSourceDisplays dataSources. This datasource can only handle Entities with Billboards, Labels or Points.

Returns DataSourceCollection
- Defined in src/map/cesiumMap.ts:1144

getCurrentResolution

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

getCurrentResolutionFromCartesian

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

getDataSourceDisplay

getDataSourceDisplay(): null | DataSourceDisplay
returns the cesium DataSourceDisplay Object

Returns null | DataSourceDisplay
- Defined in src/map/cesiumMap.ts:1350

getDatasources

getDatasources(): undefined | DataSourceCollection
returns the dataSourceCollection associated with the scene

Returns undefined | DataSourceCollection
- Defined in src/map/cesiumMap.ts:1136

getEntities

getEntities(): undefined | EntityCollection
returns the Entities Collection

Returns undefined | EntityCollection
- Defined in src/map/cesiumMap.ts:1129

getHeightFromTerrain

getHeightFromTerrain(positions): Promise<Coordinate[]>
getHeight for coordinates
Parameters
- positions: Coordinate[]
  in web mercator
Returns Promise<Coordinate[]>
the array of coordinates with heights updated in place
- Defined in src/map/cesiumMap.ts:812

getLogger

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

getScene

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

Returns undefined | Scene
- Defined in src/map/cesiumMap.ts:1357

getViewpoint

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

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

getViewpointSync

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

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

getVisualizations

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

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

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

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

gotoViewpoint

gotoViewpoint(viewpoint, optMaximumHeight?): Promise<void>
sets the view to the given viewpoint
Parameters
- viewpoint: Viewpoint
- OptionaloptMaximumHeight: number
Returns Promise<void>
Overrides VcsMap.gotoViewpoint
- Defined in src/map/cesiumMap.ts:875

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/cesiumMap.ts:1184

initialize

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

isGroundPrimitiveSupported

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

Returns boolean
- Defined in src/map/cesiumMap.ts:1411

pickPositionSupported

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

Returns boolean
- Defined in src/map/cesiumMap.ts:1401

pointIsVisible

pointIsVisible(coords): boolean
Parameters
- coords: Coordinate
Returns boolean
Overrides VcsMap.pointIsVisible
- Defined in src/map/cesiumMap.ts:1361

removeClusterDataSource

removeClusterDataSource(dataSource): void
Parameters
- dataSource: CustomDataSource
Returns void
- Defined in src/map/cesiumMap.ts:1315

removeDataSource

removeDataSource(dataSource): void
Internal API used to unregister visualizations from layer implementations
Parameters
- dataSource: CustomDataSource
Returns void
- Defined in src/map/cesiumMap.ts:1289

removeImageryLayer

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

removePrimitiveCollection

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

removeVisualization

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

requestRender

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

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

setDataSourceDisplayClock

setDataSourceDisplayClock(clock): void
set dataSource clock as display clock to visualize time dependent animation
Parameters
- clock: DataSourceClock
Returns void
- Defined in src/map/cesiumMap.ts:1025

setDay

setDay(julianDate): void
sets the position of the sun according to the day
Parameters
- julianDate: JulianDate
  See the Cesium API
Returns void
- Defined in src/map/cesiumMap.ts:1068

setDefaultShadowMap

setDefaultShadowMap(): void
Sets the default shadow map.

Returns void
- Defined in src/map/cesiumMap.ts:1110

setLightning

setLightning(value): void
sets the lighting of the globe with the sun as a light source
Parameters
- value: boolean
Returns void
- Defined in src/map/cesiumMap.ts:1078

setShadowMap

setShadowMap(shadowMap): 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
- Defined in src/map/cesiumMap.ts:1089

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

setTerrainProvider

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

toJSON

toJSON(): CesiumMapOptions
Returns CesiumMapOptions
Overrides VcsMap.toJSON
- Defined in src/map/cesiumMap.ts:1418

unsetDataSourceDisplayClock

unsetDataSourceDisplayClock(clock): void
unset dataSource clock
Parameters
- clock: DataSourceClock
Returns void
- Defined in src/map/cesiumMap.ts:1044

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/cesiumMap.ts:1338

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

`Static`getDefaultOptions

getDefaultOptions(): CesiumMapOptions
Returns CesiumMapOptions
Overrides VcsMap.getDefaultOptions
- Defined in src/map/cesiumMap.ts:304

Properties

`Optional`[moduleIdSymbol]

[moduleIdSymbol]?: string

dataSourceDisplay

dataSourceDisplay: null | DataSourceDisplay

dataSourceDisplayClock

dataSourceDisplayClock: Clock

clock for animated data

defaultJDate

defaultJDate: JulianDate

defaultTerrainProvider

defaultTerrainProvider: null | TerrainProvider

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.

enableLightning

enableLightning: boolean

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

globeColor

globeColor: Color

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>

screenSpaceEventHandler

screenSpaceEventHandler: null | ScreenSpaceEventHandler

shadowMapChanged

shadowMapChanged: VcsEvent<ShadowMap>

stateChanged

stateChanged: VcsEvent<MapState>

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

tileCacheSize

tileCacheSize: number

useOriginalCesiumShader

useOriginalCesiumShader: boolean

webGLaa

webGLaa: boolean

Class CesiumMap

Hierarchy (view full)

Index

Accessors

Constructors

Methods

Properties

Accessors

active

Returns boolean

cameraLimiter

Returns null | CameraLimiter

Parameters

Returns void

className

Returns string

defaultShadowMap

Returns null | ShadowMap

layerCollection

Returns LayerCollection

Parameters

Returns void

lightIntensity

Returns number

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 null | TerrainProvider

StaticclassName

Returns string

Constructors

constructor

Parameters

Returns CesiumMap

Methods

activate

Returns Promise<void>

addClusterDataSource

Parameters

Returns Promise<void>

addDataSource

Parameters

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

`Static`className