CesiumWidget

new Cesium.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 Object with the following properties:
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. If set to false, no skyBox, Sun, or Moon will be added.
skyAtmosphere SkyAtmosphere optional Blue sky, and the glow around the Earth's limb. Set to false to turn it off.
sceneMode SceneMode SceneMode.SCENE3D optional The initial scene mode.
scene3DOnly Boolean false optional When true, each geometry instance will only be rendered in 3D to save GPU memory.
orderIndependentTranslucency Boolean true optional If true and the configuration supports it, use order independent translucency.
mapProjection MapProjection new GeographicProjection() optional The map projection to use in 2D and Columbus View modes.
globe Globe new Globe(mapProjection.ellipsoid) optional The globe to use in the scene. If set to false, no globe will be added.
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.
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.
terrainExaggeration Number 1.0 optional A scalar used to exaggerate the terrain. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid.
shadows Boolean false optional Determines if shadows are cast by the sun.
terrainShadows Boolean false optional Determines if the terrain casts shadows from the sun.
mapMode2D MapMode2D MapMode2D.INFINITE_SCROLL optional Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
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 : Cesium.createOpenStreetMapImageryProvider(),
    terrainProvider : new Cesium.CesiumTerrainProvider({
        url : 'https://assets.agi.com/stk-terrain/v1/tilesets/world/tiles'
    }),
    // 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'
        }
    }),
    // Show Columbus View map with Web Mercator projection
    sceneMode : Cesium.SceneMode.COLUMBUS_VIEW,
    mapProjection : new Cesium.WebMercatorProjection()
});
Demo:

Members

readonlycamera : Camera

Gets the camera.

canvas : Canvas

Gets the canvas.

clock : Clock

Gets the clock.

container : Element

Gets the parent container.

creditContainer : Element

Gets the credit container.

readonlyimageryLayers : ImageryLayerCollection

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

resolutionScale : Number

Gets or sets a scaling factor for rendering resolution. Values less than 1.0 can improveperformance on less powerful devices while values greater than 1.0 will render at a higherresolution 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.5will cause the scene to be rendered at 320x240 and then scaled up while settingit to 2.0 will cause the scene to be rendered at 1280x960 and then scaled down.
Default Value: 1.0

scene : Scene

Gets the scene.

screenSpaceEventHandler : ScreenSpaceEventHandler

Gets the screen space event handler.

targetFrameRate : Number

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

terrainProvider : TerrainProvider

The terrain provider providing surface geometry for the globe.

useDefaultRenderLoop : Boolean

Gets or sets whether or not this widget should control the render loop.If set to true the widget will use requestAnimationFrame toperform rendering and resizing of the widget, as well as drive thesimulation clock. If set to false, you must manually call theresize, render methods as part of a customrender loop. If an error occurs during rendering, Scene'srenderError event will be raised and this propertywill be set to false. It must be set back to true to continue renderingafter the error.

Methods

destroy()

Destroys the widget. Should be called if permanentlyremoving the widget from layout.

isDestroyed() → Boolean

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

render()

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

resize()

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

showErrorPanel(title, message, 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 automaticallywhen a render loop error occurs, if showRenderLoopErrors was not false when thewidget was constructed.
Name Type Description
title String The title to be displayed on the error panel. This string is interpreted as text.
message String 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.