Skip to main content

Viewer

Viewer is a root component of resium same as CesiumWidget. All components of resium except the root components have to be mounted inside it.

Availability

Everywhere. Viewer is a root component.

Properties

Cesium properties

PropertyTypeDescription
shadowsboolean
resolutionScalenumber
useDefaultRenderLoopboolean
targetFrameRatenumber
useBrowserRecommendedResolutionboolean
terrainProviderTerrainProvider
terrainShadowsShadowMode
clockTrackedDataSourceDataSource
allowDataSourcesToSuspendAnimationboolean
trackedEntityEntity
selectedEntityEntity

Cesium read-only properties

PropertyTypeDescription
creditContainerstring | Element
creditViewportstring | Element
skyBoxfalse | SkyBox
skyAtmospherefalse | SkyAtmosphere
sceneModeSceneMode
scene3DOnlyboolean
orderIndependentTranslucencyboolean
mapProjectionMapProjection
globefalse | Globe
showRenderLoopErrorsboolean
contextOptionsContextOptions
mapMode2DMapMode2D
blurActiveElementOnCanvasFocusboolean
requestRenderModeboolean
maximumRenderTimeChangenumber
msaaSamplesnumber
shouldAnimateboolean
selectionIndicatorboolean
infoBoxboolean
geocoderboolean | GeocoderService[]
homeButtonboolean
sceneModePickerboolean
projectionPickerboolean
baseLayerPickerboolean
navigationHelpButtonboolean
animationboolean
timelineboolean
fullscreenButtonboolean
vrButtonboolean
dataSourcesDataSourceCollection
clockViewModelClockViewModel
navigationInstructionsInitiallyVisibleboolean
selectedImageryProviderViewModelProviderViewModel
imageryProviderViewModelsProviderViewModel[]
selectedTerrainProviderViewModelProviderViewModel
terrainProviderViewModelsProviderViewModel[]
fullscreenElementstring | Element
automaticallyTrackDataSourceClocksboolean
depthPlaneEllipsoidOffsetnumber
imageryProviderfalse | ImageryProviderIf false, the default imagery layer will be removed.

Cesium events

PropertyTypeDescription
onSelectedEntityChange(entity: Entity) => void
onTrackedEntityChange(entity: Entity) => void

Other properties

N/A