Viewer

//Initialize the viewer widget with several custom options and mixins.
var viewer = new Viewer('cesiumContainer', {
    //Start in Columbus Viewer
    sceneMode : SceneMode.COLUMBUS_VIEW,
    //Use standard Cesium terrain
    terrainProvider : new CesiumTerrainProvider({
        url : 'http://cesium.agi.com/smallterrain',
        credit : 'Terrain data courtesy Analytical Graphics, Inc.'
    }),
    //Hide the base layer picker
    baseLayerPicker : false,
    //Use OpenStreetMaps
    selectedImageryProviderViewModel : new ImageryProviderViewModel({
        name : 'Open\u00adStreet\u00adMap',
        iconUrl : buildModuleUrl('Widgets/Images/ImageryProviders/openStreetMap.png'),
        tooltip : 'OpenStreetMap (OSM) is a collaborative project to create a free editable map',
        creationFunction : function() {
            return new OpenStreetMapImageryProvider({
                url : 'http://tile.openstreetmap.org/'
            });
        }
    })
});

//Add basic drag and drop functionality
viewer.extend(viewerDragDropMixin);

//Allow users to zoom and follow objects loaded from CZML by clicking on it.
viewer.extend(viewerDynamicObjectMixin);

//Show a pop-up alert if we encounter an error when processing a dropped file
viewer.onDropError.addEventListener(function(dropHandler, name, error) {
    console.log(error);
    window.alert(error);
});

Members

animation :Animation

Gets the Animation widget.

baseLayerPicker :BaseLayerPicker

Gets the BaseLayerPicker.

canvas

Gets the canvas.

centralBody

Gets the primary central body.

cesiumLogo

Gets the Cesium logo element.

cesiumWidget :CesiumWidget

Gets the CesiumWidget.

clock

Gets the clock.

container :Element

Gets the parent container.

dataSourceDisplay :DataSourceDisplay

Gets the display used for DataSource visualization.

dataSources :DataSourceCollection

Gets the set of DataSource instances to be visualized.

fullscreenButton :FullscreenButton

Gets the FullscreenButton.

homeButton :HomeButton

Gets the HomeButton.

onRenderLoopError :Event

Gets the event that will be raised when an error is encountered during the default render loop. The widget instance and the generated exception are the only two parameters passed to the event handler. useDefaultRenderLoop will be set to false whenever an exception is generated and must be set back to true to continue rendering after an exception.

onRenderLoopError :Event

Gets the event that will be raised when an error is encountered during the default render loop. The viewer instance and the generated exception are the only two parameters passed to the event handler. useDefaultRenderLoop will be set to false whenever an exception is generated and must be set back to true to continue rendering after an exception.

scene

Gets the scene.

sceneModePicker :SceneModePicker

Gets the SceneModePicker.

sceneTransitioner

Gets the scene transitioner.

screenSpaceEventHandler

Gets the screen space event handler.

timeline :Timeline

Gets the Timeline widget.

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.

Methods

destroy

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

extend

Extends the base viewer functionality with the provided mixin. A mixin may add additional properties, functions, or other behavior to the provided viewer instance.

Parameters:

Name	Type	Description
mixin		The Viewer mixin to add to this instance.
options		The options object to be passed to the mixin function.

See:

• viewerDragDropMixin
• viewerDynamicObjectMixin

isDestroyed

Returns:

Boolean true if the object has been destroyed, false otherwise.

render

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

resize

Resizes the widget to match the container size. This function is called automatically as needed unless useDefaultRenderLoop is set to false.