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:
|
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', {
imageryProvider : Cesium.createWorldImagery(),
terrainProvider : Cesium.createWorldTerrain(),
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
Gets the camera.
Gets the canvas.
readonly clock : Clock
Gets the clock.
Gets the parent container.
Gets the credit container.
Gets the credit viewport
readonly imageryLayers : ImageryLayerCollection
Gets the collection of image layers that will be rendered on the globe.
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
Gets the scene.
readonly screenSpaceEventHandler : ScreenSpaceEventHandler
Gets the screen space event handler.
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
The terrain provider providing surface geometry for the globe.
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
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
Destroys the widget. Should be called if permanently
removing the widget from layout.
Returns:
true if the object has been destroyed, false otherwise.
Renders the scene. This function is called automatically
unless
useDefaultRenderLoop is set to false;
Updates the canvas size, camera aspect ratio, and viewport size.
This function is called automatically as needed unless
useDefaultRenderLoop is set to false.
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. |