CesiumWidget

new CesiumWidget(container, options)

A widget containing a Cesium scene.
Name Type Description
container Element | String The DOM element or ID that will contain the widget.
options Object optional Configuration options for the widget.
Name Type Default Description
clock Clock new Clock() optional The clock to use to control current time.
imageryProvider ImageryProvider new BingMapsImageryProvider() optional The imagery provider to serve as the base layer. If set to false, no imagery provider will be added.
terrainProvider TerrainProvider new EllipsoidTerrainProvider optional The terrain provider.
skyBox SkyBox optional The skybox used to render the stars. When undefined, the default stars are used.
sceneMode SceneMode SceneMode.SCENE3D optional The initial scene mode.
useDefaultRenderLoop Boolean true optional True if this widget should control the render loop, false otherwise.
targetFrameRate Number optional The target frame rate when using the default render loop.
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.
contextOptions Object optional Context and WebGL creation properties corresponding to options passed to Scene.
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.
var widget = new Cesium.CesiumWidget('cesiumContainer');

//Widget with OpenStreetMaps imagery provider and Cesium terrain provider hosted by AGI.
var widget = new Cesium.CesiumWidget('cesiumContainer', {
    imageryProvider : new Cesium.OpenStreetMapImageryProvider(),
    terrainProvider : new Cesium.CesiumTerrainProvider({
        url : '//cesiumjs.org/smallterrain',
        credit : 'Terrain data courtesy Analytical Graphics, Inc.'
    }),
    // Use high-res stars downloaded from https://github.com/AnalyticalGraphicsInc/cesium-assets
    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'
        }
    })
});
Source: Widgets/CesiumWidget/CesiumWidget.js, line 141

Members

canvas :Canvas

Gets the canvas.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 288

clock :Clock

Gets the clock.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 324

container :Element

Gets the parent container.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 276

creditContainer :Element

Gets the credit container.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 300

resolutionScale :Number

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
Source: Widgets/CesiumWidget/CesiumWidget.js, line 403

scene :Scene

Gets the scene.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 312

screenSpaceEventHandler :ScreenSpaceEventHandler

Gets the screen space event handler.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 336

targetFrameRate :Number

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. This value must be greater than 0 and a value higher than the underlying requestAnimationFrame implementatin will have no affect.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 351

useDefaultRenderLoop :Boolean

Gets or sets whether or not this widget should control the render loop. If set to 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.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 377

Methods

destroy()

Destroys the widget. Should be called if permanently removing the widget from layout.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 494

isDestroyed() → Boolean

Returns:
true if the object has been destroyed, false otherwise.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 485

render()

Renders the scene. This function is called automatically unless useDefaultRenderLoop is set to false;
Source: Widgets/CesiumWidget/CesiumWidget.js, line 545

resize()

Updates the canvas size, camera aspect ratio, and viewport size. This function is called automatically as needed unless useDefaultRenderLoop is set to false.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 506

showErrorPanel(title, error)

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.
error String The error to be displayed on the error panel. Optional.
Source: Widgets/CesiumWidget/CesiumWidget.js, line 428