Skip to main content

CesiumWidget

CesiumWidget is the simplest root component of resium. All components of resium except the root components have to be mounted inside it.

Viewer is also a root component. It is a component with some widgets (info box, timeline, and so on) added to CesiumWidget.

Availability

Everywhere. CesiumWidget is a root component.

Properties

Cesium properties

PropertyTypeDescription
resolutionScalenumber
useDefaultRenderLoopboolean
targetFrameRatenumber
useBrowserRecommendedResolutionboolean

Cesium read-only properties

PropertyTypeDescription
shadowsboolean
creditContainerstring | Element
creditViewportstring | Element
terrainProviderTerrainProvider
clockClock
imageryProviderfalse | ImageryProvider
skyBoxfalse | SkyBox
skyAtmospherefalse | SkyAtmosphere
sceneModeSceneMode
scene3DOnlyboolean
orderIndependentTranslucencyboolean
mapProjectionMapProjection
globefalse | Globe
showRenderLoopErrorsboolean
contextOptionsany
terrainShadowsShadowMode
mapMode2DMapMode2D
requestRenderModeboolean
maximumRenderTimeChangenumber
msaaSamplesnumber

Cesium events

N/A

Other properties

PropertyTypeDescription
onClick(movement: CesiumMovementEvent, target: T) => void
onDoubleClick(movement: CesiumMovementEvent, target: T) => void
onMouseDown(movement: CesiumMovementEvent, target: T) => void
onMouseUp(movement: CesiumMovementEvent, target: T) => void
onMiddleClick(movement: CesiumMovementEvent, target: T) => void
onMiddleDown(movement: CesiumMovementEvent, target: T) => void
onMiddleUp(movement: CesiumMovementEvent, target: T) => void
onMouseMove(movement: CesiumMovementEvent, target: T) => void
onPinchEnd(movement: CesiumMovementEvent, target: T) => void
onPinchMove(movement: CesiumMovementEvent, target: T) => void
onPinchStart(movement: CesiumMovementEvent, target: T) => void
onRightClick(movement: CesiumMovementEvent, target: T) => void
onRightDown(movement: CesiumMovementEvent, target: T) => void
onRightUp(movement: CesiumMovementEvent, target: T) => void
onMouseEnter(movement: CesiumMovementEvent, target: T) => void
onMouseLeave(movement: CesiumMovementEvent, target: T) => void
onWheel(delta: number) => void
classNamestringApplied to outer div element
idstringApplied to outer div element
styleCSSPropertiesApplied to outer div element
fullbooleanSame as style={{ position: "absolute", top: 0, left: 0, right: 0, bottom: 0 }} if it is true.
containerPropsanyAll props applied to outer div element
childrenReactNode