# CesiumWidget

#### new Cesium.CesiumWidget(container, options)
Widgets/CesiumWidget/CesiumWidget.js 226

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 | `createWorldImagery()` | 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.
`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.
`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` | ShadowMode | `ShadowMode.RECEIVE_ONLY` | optional Determines if the terrain casts or receives 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.

`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.

`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.

##### 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 World Terrain.
    var widget = new Cesium.CesiumWidget('cesiumContainer', {
        imageryProvider : Cesium.createOpenStreetMapImageryProvider(),
        terrainProvider : Cesium.createWorldTerrain(),
        // 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:

- Cesium Sandcastle Cesium Widget Demo

### Members

#### readonlycamera : Camera
Widgets/CesiumWidget/CesiumWidget.js 555

Gets the camera.

#### canvas : Canvas
Widgets/CesiumWidget/CesiumWidget.js 478

Gets the canvas.

#### clock : Clock
Widgets/CesiumWidget/CesiumWidget.js 567

Gets the clock.

#### container : Element
Widgets/CesiumWidget/CesiumWidget.js 466

Gets the parent container.

#### creditContainer : Element
Widgets/CesiumWidget/CesiumWidget.js 490

Gets the credit container.

#### creditViewport : Element
Widgets/CesiumWidget/CesiumWidget.js 502

Gets the credit viewport

#### readonlyimageryLayers : ImageryLayerCollection
Widgets/CesiumWidget/CesiumWidget.js 527

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

#### resolutionScale : Number
Widgets/CesiumWidget/CesiumWidget.js 648

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`

#### scene : Scene
Widgets/CesiumWidget/CesiumWidget.js 514

Gets the scene.

#### screenSpaceEventHandler : ScreenSpaceEventHandler
Widgets/CesiumWidget/CesiumWidget.js 579

Gets the screen space event handler.

#### targetFrameRate : Number
Widgets/CesiumWidget/CesiumWidget.js 594

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
Widgets/CesiumWidget/CesiumWidget.js 539

The terrain provider providing surface geometry for the globe.

#### useDefaultRenderLoop : Boolean
Widgets/CesiumWidget/CesiumWidget.js 622

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.

### Methods

#### destroy()
Widgets/CesiumWidget/CesiumWidget.js 752

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

#### isDestroyed() → Boolean
Widgets/CesiumWidget/CesiumWidget.js 744

##### Returns:

true if the object has been destroyed, false otherwise.

#### render()
Widgets/CesiumWidget/CesiumWidget.js 783

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

#### resize()
Widgets/CesiumWidget/CesiumWidget.js 764

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)
Widgets/CesiumWidget/CesiumWidget.js 674

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 | 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.