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
Section titled “Availability”Everywhere. Viewer is a root component.
Example
Section titled “Example”<Viewer full animation={false} timeline={false} />Properties
Section titled “Properties”Cesium properties
Section titled “Cesium properties”| Property | Type | Description |
|---|---|---|
| shadows | boolean | |
| resolutionScale | number | |
| useDefaultRenderLoop | boolean | |
| targetFrameRate | number | |
| useBrowserRecommendedResolution | boolean | |
| allowDataSourcesToSuspendAnimation | boolean | |
| trackedEntity | Entity | undefined | |
| clockTrackedDataSource | DataSource | |
| creditDisplay | CreditDisplay | |
| terrainShadows | ShadowMode | |
| selectedEntity | Entity | undefined |
Cesium read-only properties
Section titled “Cesium read-only properties”| Property | Type | Description |
|---|---|---|
| ellipsoid | Ellipsoid | undefined | |
| creditContainer | string | Element | undefined | |
| creditViewport | string | Element | undefined | |
| dataSources | DataSourceCollection | undefined | |
| shouldAnimate | boolean | undefined | |
| baseLayer | false | ImageryLayer | undefined | |
| terrain | Terrain | undefined | |
| skyBox | false | SkyBox | undefined | |
| skyAtmosphere | false | SkyAtmosphere | undefined | |
| sceneMode | SceneMode | undefined | |
| scene3DOnly | boolean | undefined | |
| orderIndependentTranslucency | boolean | undefined | |
| mapProjection | MapProjection | undefined | |
| globe | false | Globe | undefined | |
| showRenderLoopErrors | boolean | undefined | |
| automaticallyTrackDataSourceClocks | boolean | undefined | |
| contextOptions | ContextOptions | undefined | |
| mapMode2D | MapMode2D | undefined | |
| blurActiveElementOnCanvasFocus | boolean | undefined | |
| requestRenderMode | boolean | undefined | |
| maximumRenderTimeChange | number | undefined | |
| msaaSamples | number | undefined | |
| selectionIndicator | boolean | undefined | |
| infoBox | boolean | undefined | |
| geocoder | boolean | IonGeocodeProviderType | GeocoderService[] | undefined | |
| homeButton | boolean | undefined | |
| sceneModePicker | boolean | undefined | |
| projectionPicker | boolean | undefined | |
| baseLayerPicker | boolean | undefined | |
| navigationHelpButton | boolean | undefined | |
| animation | boolean | undefined | |
| timeline | boolean | undefined | |
| fullscreenButton | boolean | undefined | |
| vrButton | boolean | undefined | |
| clockViewModel | ClockViewModel | undefined | |
| navigationInstructionsInitiallyVisible | boolean | undefined | |
| selectedImageryProviderViewModel | ProviderViewModel | undefined | |
| imageryProviderViewModels | ProviderViewModel[] | undefined | |
| selectedTerrainProviderViewModel | ProviderViewModel | undefined | |
| terrainProviderViewModels | ProviderViewModel[] | undefined | |
| fullscreenElement | string | Element | undefined | |
| depthPlaneEllipsoidOffset | number | undefined |
Cesium events
Section titled “Cesium events”| Property | Type | Description |
|---|---|---|
| onSelectedEntityChange | ((entity: Entity | undefined) => void) | undefined | |
| onTrackedEntityChange | ((entity: Entity | undefined) => void) | undefined |
Other properties
Section titled “Other properties”N/A