Class CesiumMap

Cesium Globe Map Class (3D map)

Hierarchy

Accessors

active cameraLimiter className layerCollection lightIntensity loading postRender splitPosition target terrainProvider className

Constructors

constructor

Methods

_getCurrentResolutionFromCartesianLatitude _raisePointerInteraction _setupInteractions _setupPreUpdateListener _terrainProviderChanged activate addDataSource addImageryLayer addPrimitiveCollection addVisualization canShowViewpoint deactivate destroy disableMovement getCesiumWidget getClusterDatasources getCurrentResolution getCurrentResolutionFromCartesian getDataSourceDisplay getDatasources getEntities getHeightFromTerrain getLogger getScene getViewpoint getViewpointSync getVisualizations getVisualizationsForLayer gotoViewpoint indexChanged initialize isGroundPrimitiveSupported pickPositionSupported pointIsVisible removeDataSource removeImageryLayer removePrimitiveCollection removeVisualization requestRender setDataSourceDisplayClock setDay setLightning setTarget setTerrainProvider toJSON unsetDataSourceDisplayClock unsetTerrainProvider validateVisualization getDefaultOptions

Properties

[moduleIdSymbol]? _cameraLimiter _cameraLimiterOptions _cesiumWidget _clockSyncListener _clusterDataSourceDisplay _dataSourceClocks _defaultClock _lastEventFrameNumber _lightIntensity _listeners _preUpdateListener _screenSpaceListeners _terrainProvider dataSourceDisplay dataSourceDisplayClock defaultJDate defaultTerrainProvider destroyLayerCollection enableLightning fallbackMap globeColor initialized isDestroyed mapElement movementDisabled name pointerInteractionEvent properties screenSpaceEventHandler stateChanged tileCacheSize useOriginalCesiumShader webGLaa

Accessors

active

  • get active(): boolean

  • Whether the map is active or not

    Returns boolean

cameraLimiter

className

  • get className(): string

  • Returns string

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

lightIntensity

loading

  • get loading(): boolean

  • Whether the map is loading or not

    Returns boolean

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

Static className

Constructors

constructor

Methods

Private _getCurrentResolutionFromCartesianLatitude

  • _getCurrentResolutionFromCartesianLatitude(cartesian, latitude): number

  • Parameters

    • cartesian: Cartesian3
    • latitude: number

    Returns number

Private _raisePointerInteraction

Private _setupInteractions

Private _setupPreUpdateListener

Private _terrainProviderChanged

  • _terrainProviderChanged(terrainProvider): void

  • is called when the cesium Terrainprovider changes. Sets the .terrainProvider and deactivates currently active TerrainLayer layer if necessary

    Parameters

    • terrainProvider: TerrainProvider

    Returns void

activate

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

addDataSource

  • Internal API used to register visualizations from layer implementations

    Parameters

    • dataSource: CustomDataSource

    Returns Promise<void>

addImageryLayer

  • Internal API used to register visualizations from layer implementations

    Parameters

    • imageryLayer: ImageryLayer

    Returns void

addPrimitiveCollection

  • Internal API used to register visualizations from layer implementations

    Parameters

    • primitiveCollection: PrimitiveCollection | Cesium3DTileset

    Returns void

addVisualization

canShowViewpoint

deactivate

destroy

disableMovement

  • prevent all movement, including navigation controls, gotoViewpoint & setting of oblique images

    Parameters

    • bool: boolean

    Returns void

getCesiumWidget

  • returns the cesium Widget Object

    Returns null | CesiumWidget

getClusterDatasources

  • Returns the cluster dataSourceDisplays dataSources. This datasource can only handle Entities with Billboards, Labels or Points.

    Returns DataSourceCollection

getCurrentResolution

  • Resolution in meters per pixe

    Parameters

    • coordinate: Coordinate

      coordinate in mercator for which to determine resolution. only required in 3D

    Returns number

getCurrentResolutionFromCartesian

  • Parameters

    • cartesian: Cartesian3

    Returns number

getDataSourceDisplay

  • returns the cesium DataSourceDisplay Object

    Returns null | DataSourceDisplay

getDatasources

  • returns the dataSourceCollection associated with the scene

    Returns undefined | DataSourceCollection

getEntities

  • returns the Entities Collection

    Returns undefined | EntityCollection

getHeightFromTerrain

  • getHeight for coordinates

    Parameters

    • positions: Coordinate[]

      in web mercator

    Returns Promise<Coordinate[]>

    the array of coordinates with heights updated in place

getLogger

getScene

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

    Returns undefined | Scene

getViewpoint

getViewpointSync

getVisualizations

getVisualizationsForLayer

gotoViewpoint

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

indexChanged

initialize

isGroundPrimitiveSupported

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

    Returns boolean

pickPositionSupported

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

    Returns boolean

pointIsVisible

removeDataSource

  • Internal API used to unregister visualizations from layer implementations

    Parameters

    • dataSource: CustomDataSource

    Returns void

removeImageryLayer

  • Internal API used to unregister visualizations from layer implementations

    Parameters

    • imageryLayer: ImageryLayer

    Returns void

removePrimitiveCollection

  • Internal API to unregister the visualization for a layers implementation

    Parameters

    • primitiveCollection: PrimitiveCollection | Cesium3DTileset

    Returns void

removeVisualization

requestRender

setDataSourceDisplayClock

  • set dataSource clock as display clock to visualize time dependent animation

    Parameters

    • clock: DataSourceClock

    Returns void

setDay

  • sets the position of the sun according to the day

    Parameters

    • julianDate: JulianDate

      See the Cesium API

    Returns void

setLightning

  • sets the lighting of the globe with the sun as a light source

    Parameters

    • value: boolean

    Returns void

setTarget

setTerrainProvider

  • set the cesium TerrainProvider

    Parameters

    • terrainProvider: TerrainProvider

    Returns void

toJSON

unsetDataSourceDisplayClock

  • unset dataSource clock

    Parameters

    • clock: DataSourceClock

    Returns void

unsetTerrainProvider

  • unsets the TerrainProvider (changes to the default TerrainProvider if the given terranProvider is currently active)

    Parameters

    • terrainProvider: TerrainProvider

    Returns void

validateVisualization

Static getDefaultOptions

Properties

Optional [moduleIdSymbol]

[moduleIdSymbol]?: string

Private _cameraLimiter

_cameraLimiter: null | CameraLimiter

Private _cameraLimiterOptions

_cameraLimiterOptions: undefined | CameraLimiterOptions

Private _cesiumWidget

_cesiumWidget: null | CesiumWidget

Private _clockSyncListener

_clockSyncListener: null | (() => void)

Type declaration

    • (): void

    • Returns void

Private _clusterDataSourceDisplay

_clusterDataSourceDisplay: null | DataSourceDisplay

Private _dataSourceClocks

_dataSourceClocks: DataSourceClock[]

clocks of active data sources the last clock of the array corresponds to the active dataSourceDisplayClock

Private _defaultClock

_defaultClock: DataSourceClock

default clock is set, when no datasource clock is active

Private _lastEventFrameNumber

_lastEventFrameNumber: null | number

Private _lightIntensity

_lightIntensity: number

Private _listeners

_listeners: (() => void)[]

Type declaration

    • (): void

    • Returns void

Private _preUpdateListener

_preUpdateListener: null | (() => void)

Type declaration

    • (): void

    • Returns void

Private _screenSpaceListeners

_screenSpaceListeners: (() => void)[]

Type declaration

    • (): void

    • Returns void

Private _terrainProvider

_terrainProvider: null | TerrainProvider

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

globeColor

globeColor: Color

initialized

initialized: boolean

isDestroyed

isDestroyed: boolean

mapElement

mapElement: HTMLElement

movementDisabled

movementDisabled: boolean

if true, no movements should occur

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

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc