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
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.
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'
}
}),
// Show Columbus View map with Web Mercator projection
sceneMode : Cesium.SceneMode.COLUMBUS_VIEW,
mapProjection : new Cesium.WebMercatorProjection()
});Demo:
Members
-
canvas :Canvas
-
Gets the canvas.
-
clock :Clock
-
Gets the clock.
-
container :Element
-
Gets the parent container.
-
creditContainer :Element
-
Gets the credit container.
-
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 -
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'srequestAnimationFrameimplementation determines the frame rate. This value must be greater than 0 and a value higher than the underlying requestAnimationFrame implementatin will have no affect. -
useDefaultRenderLoop :Boolean
-
Gets or sets whether or not this widget should control the render loop. If set to true the widget will use
requestAnimationFrameto perform rendering and resizing of the widget, as well as drive the simulation clock. If set to false, you must manually call theresize,rendermethods as part of a custom render loop. If an error occurs during rendering,Scene'srenderErrorevent 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()
-
Destroys the widget. Should be called if permanently removing the widget from layout.
-
isDestroyed() → Boolean
-
Returns:
true if the object has been destroyed, false otherwise. -
render()
-
Renders the scene. This function is called automatically unless
useDefaultRenderLoopis set to false; -
resize()
-
Updates the canvas size, camera aspect ratio, and viewport size. This function is called automatically as needed unless
useDefaultRenderLoopis 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 automatically when a render loop error occurs, if showRenderLoopErrors was not false when the widget was constructed.
Name Type Description titleString The title to be displayed on the error panel. This string is interpreted as text. messageString A helpful, user-facing message to display prior to the detailed error information. This string is interpreted as HTML. errorString optional The error to be displayed on the error panel. This string is formatted using formatErrorand then displayed as text.