CesiumWidget

new Cesium.CesiumWidget(container, options, baseLayer)
engine/Source/Widget/CesiumWidget.js 184

A widget containing a Cesium scene.
Name Type Default Description
container Element | string The DOM element or ID that will contain the widget.
options object optional Object with the following properties:
Name Type Default Description
clock Clock new Clock() optional The clock to use to control current time.
imageryProvider ImageryProvider | false createWorldImagery() optional The imagery provider to serve as the base layer. If set to false, no imagery provider will be added. Deprecated.
baseLayer ImageryLayer | false ImageryLayer.fromWorldImagery() optional The bottommost imagery layer applied to the globe. If set to false, no imagery provider will be added.
options.terrainProvider TerrainProvider new EllipsoidTerrainProvider optional The terrain provider.
options.terrain Terrain optional A terrain object which handles asynchronous terrain provider. Can only specify if options.terrainProvider is undefined.
options.skyBox SkyBox | false optional The skybox used to render the stars. When undefined, the default stars are used. If set to false, no skyBox, Sun, or Moon will be added.
options.skyAtmosphere SkyAtmosphere | false optional Blue sky, and the glow around the Earth's limb. Set to false to turn it off.
options.sceneMode SceneMode SceneMode.SCENE3D optional The initial scene mode.
options.scene3DOnly boolean false optional When true, each geometry instance will only be rendered in 3D to save GPU memory.
options.orderIndependentTranslucency boolean true optional If true and the configuration supports it, use order independent translucency.
options.mapProjection MapProjection new GeographicProjection() optional The map projection to use in 2D and Columbus View modes.
options.globe Globe | false new Globe(mapProjection.ellipsoid) optional The globe to use in the scene. If set to false, no globe will be added.
options.useDefaultRenderLoop boolean true optional True if this widget should control the render loop, false otherwise.
options.useBrowserRecommendedResolution boolean true optional If true, render at the browser's recommended resolution and ignore window.devicePixelRatio.
options.targetFrameRate number optional The target frame rate when using the default render loop.
options.showRenderLoopErrors boolean true optional If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.
options.contextOptions ContextOptions optional Context and WebGL creation properties passed to Scene.
options.creditContainer Element | string optional The DOM element or ID that will contain the CreditDisplay. If not specified, the credits are added to the bottom of the widget itself.
options.creditViewport Element | string optional The DOM element or ID that will contain the credit pop up created by the CreditDisplay. If not specified, it will appear over the widget itself.
options.shadows boolean false optional Determines if shadows are cast by light sources.
options.terrainShadows ShadowMode ShadowMode.RECEIVE_ONLY optional Determines if the terrain casts or receives shadows from light sources.
options.mapMode2D MapMode2D MapMode2D.INFINITE_SCROLL optional Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
options.blurActiveElementOnCanvasFocus boolean true optional If true, the active element will blur when the viewer's canvas is clicked. Setting this to false is useful for cases when the canvas is clicked only for retrieving position or an entity data without actually meaning to set the canvas to be the active element.
options.requestRenderMode boolean false optional If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using Scene#requestRender to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See Improving Performance with Explicit Rendering.
options.maximumRenderTimeChange number 0.0 optional If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See Improving Performance with Explicit Rendering.
options.msaaSamples number 1 optional If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets.
Throws:
  • DeveloperError : Element with id "container" does not exist in the document.
Example:
// For each example, include a link to CesiumWidget.css stylesheet in HTML head,
// and in the body, include: <div id="cesiumContainer"></div>

// Widget with no terrain and default Bing Maps imagery provider.
const widget = new Cesium.CesiumWidget("cesiumContainer");

// Widget with ion imagery and Cesium World Terrain.
const widget2 = new Cesium.CesiumWidget("cesiumContainer", {
    baseLayer: Cesium.ImageryLayer.fromWorldTerrain(),
    terrain: Cesium.Terrain.fromWorldTerrain()
    skyBox: new Cesium.SkyBox({
      sources: {
        positiveX: "stars/TychoSkymapII.t3_08192x04096_80_px.jpg",
        negativeX: "stars/TychoSkymapII.t3_08192x04096_80_mx.jpg",
        positiveY: "stars/TychoSkymapII.t3_08192x04096_80_py.jpg",
        negativeY: "stars/TychoSkymapII.t3_08192x04096_80_my.jpg",
        positiveZ: "stars/TychoSkymapII.t3_08192x04096_80_pz.jpg",
        negativeZ: "stars/TychoSkymapII.t3_08192x04096_80_mz.jpg"
      }
    }),
    // Show Columbus View map with Web Mercator projection
    sceneMode: Cesium.SceneMode.COLUMBUS_VIEW,
    mapProjection: new Cesium.WebMercatorProjection()
});
Demo:

Members

readonly camera : Camera
engine/Source/Widget/CesiumWidget.js 542

Gets the camera.

readonly canvas : HTMLCanvasElement
engine/Source/Widget/CesiumWidget.js 450

Gets the canvas.

readonly clock : Clock
engine/Source/Widget/CesiumWidget.js 555

Gets the clock.

readonly container : Element
engine/Source/Widget/CesiumWidget.js 437

Gets the parent container.

readonly creditContainer : Element
engine/Source/Widget/CesiumWidget.js 463

Gets the credit container.

creditDisplay : CreditDisplay
engine/Source/Widget/CesiumWidget.js 529

Manages the list of credits to display on screen and in the lightbox.

readonly creditViewport : Element
engine/Source/Widget/CesiumWidget.js 476

Gets the credit viewport

readonly imageryLayers : ImageryLayerCollection
engine/Source/Widget/CesiumWidget.js 502

Gets the collection of image layers that will be rendered on the globe.

resolutionScale : number
engine/Source/Widget/CesiumWidget.js 639

Gets or sets a scaling factor for rendering resolution. Values less than 1.0 can improve performance on less powerful devices while values greater than 1.0 will render at a higher resolution and then scale down, resulting in improved visual fidelity. For example, if the widget is laid out at a size of 640x480, setting this value to 0.5 will cause the scene to be rendered at 320x240 and then scaled up while setting it to 2.0 will cause the scene to be rendered at 1280x960 and then scaled down.
Default Value: 1.0

readonly scene : Scene
engine/Source/Widget/CesiumWidget.js 489

Gets the scene.

readonly screenSpaceEventHandler : ScreenSpaceEventHandler
engine/Source/Widget/CesiumWidget.js 568

Gets the screen space event handler.

targetFrameRate : number
engine/Source/Widget/CesiumWidget.js 583

Gets or sets the target frame rate of the widget when useDefaultRenderLoop is true. If undefined, the browser's requestAnimationFrame implementation determines the frame rate. If defined, this value must be greater than 0. A value higher than the underlying requestAnimationFrame implementation will have no effect.

terrainProvider : TerrainProvider
engine/Source/Widget/CesiumWidget.js 514

The terrain provider providing surface geometry for the globe.

useBrowserRecommendedResolution : boolean
engine/Source/Widget/CesiumWidget.js 668

Boolean flag indicating if the browser's recommended resolution is used. If true, the browser's device pixel ratio is ignored and 1.0 is used instead, effectively rendering based on CSS pixels instead of device pixels. This can improve performance on less powerful devices that have high pixel density. When false, rendering will be in device pixels. CesiumWidget#resolutionScale will still take effect whether this flag is true or false.
Default Value: true

useDefaultRenderLoop : boolean
engine/Source/Widget/CesiumWidget.js 613

Gets or sets whether or not this widget should control the render loop. If true the widget will use requestAnimationFrame to perform rendering and resizing of the widget, as well as drive the simulation clock. If set to false, you must manually call the resize, render methods as part of a custom render loop. If an error occurs during rendering, Scene's renderError event will be raised and this property will be set to false. It must be set back to true to continue rendering after the error.

Methods

destroy()
engine/Source/Widget/CesiumWidget.js 801

Destroys the widget. Should be called if permanently removing the widget from layout.

isDestroyed() → boolean
engine/Source/Widget/CesiumWidget.js 793

Returns:
true if the object has been destroyed, false otherwise.

render()
engine/Source/Widget/CesiumWidget.js 838

Renders the scene. This function is called automatically unless useDefaultRenderLoop is set to false;

resize()
engine/Source/Widget/CesiumWidget.js 816

Updates the canvas size, camera aspect ratio, and viewport size. This function is called automatically as needed unless useDefaultRenderLoop is set to false.

showErrorPanel(title, message, error)
engine/Source/Widget/CesiumWidget.js 691

Show an error panel to the user containing a title and a longer error message, which can be dismissed using an OK button. This panel is displayed automatically when a render loop error occurs, if showRenderLoopErrors was not false when the widget was constructed.
Name Type Description
title string The title to be displayed on the error panel. This string is interpreted as text.
message string optional A helpful, user-facing message to display prior to the detailed error information. This string is interpreted as HTML.
error string optional The error to be displayed on the error panel. This string is formatted using formatError and then displayed as text.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets