Class: Viewer

Viewer

new Viewer(container, optionsopt)

A base widget for building applications. It composites all of the standard Cesium widgets into one reusable package. The widget can always be extended by using mixins, which add functionality useful for a variety of applications.
Parameters:
Name Type Attributes Description
container Element | String The DOM element or ID that will contain the widget.
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
animation Boolean <optional>
 true If set to false, the Animation widget will not be created.
baseLayerPicker Boolean <optional>
 true If set to false, the BaseLayerPicker widget will not be created.
fullscreenButton Boolean <optional>
 true If set to false, the FullscreenButton widget will not be created.
vrButton Boolean <optional>
 false If set to true, the VRButton widget will be created.
geocoder Boolean <optional>
 true If set to false, the Geocoder widget will not be created.
homeButton Boolean <optional>
 true If set to false, the HomeButton widget will not be created.
infoBox Boolean <optional>
 true If set to false, the InfoBox widget will not be created.
sceneModePicker Boolean <optional>
 true If set to false, the SceneModePicker widget will not be created.
selectionIndicator Boolean <optional>
 true If set to false, the SelectionIndicator widget will not be created.
timeline Boolean <optional>
 true If set to false, the Timeline widget will not be created.
navigationHelpButton Boolean <optional>
 true If set to false, the navigation help button will not be created.
navigationInstructionsInitiallyVisible Boolean <optional>
 true True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button.
scene3DOnly Boolean <optional>
 false When true, each geometry instance will only be rendered in 3D to save GPU memory.
clock Clock <optional>
 new Clock() The clock to use to control current time.
selectedImageryProviderViewModel ProviderViewModel <optional>
 The view model for the current base imagery layer, if not supplied the first available base layer is used. This value is only valid if options.baseLayerPicker is set to true.
imageryProviderViewModels Array.<ProviderViewModel> <optional>
 createDefaultImageryProviderViewModels() The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true.
selectedTerrainProviderViewModel ProviderViewModel <optional>
 The view model for the current base terrain layer, if not supplied the first available base layer is used. This value is only valid if options.baseLayerPicker is set to true.
terrainProviderViewModels Array.<ProviderViewModel> <optional>
 createDefaultTerrainProviderViewModels() The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true.
imageryProvider ImageryProvider <optional>
 new BingMapsImageryProvider() The imagery provider to use. This value is only valid if options.baseLayerPicker is set to false.
terrainProvider TerrainProvider <optional>
 new EllipsoidTerrainProvider() The terrain provider to use
skyBox SkyBox <optional>
 The skybox used to render the stars. When undefined, the default stars are used.
skyAtmosphere SkyAtmosphere <optional>
 Blue sky, and the glow around the Earth's limb. Set to false to turn it off.
fullscreenElement Element | String <optional>
 document.body The element or id to be placed into fullscreen mode when the full screen button is pressed.
useDefaultRenderLoop Boolean <optional>
 true 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 <optional>
 true If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.
automaticallyTrackDataSourceClocks Boolean <optional>
 true If true, this widget will automatically track the clock settings of newly added DataSources, updating if the DataSource's clock changes. Set this to false if you want to configure the clock independently.
contextOptions Object <optional>
 Context and WebGL creation properties corresponding to options passed to Scene.
sceneMode SceneMode <optional>
 SceneMode.SCENE3D The initial scene mode.
mapProjection MapProjection <optional>
 new GeographicProjection() The map projection to use in 2D and Columbus View modes.
globe Globe <optional>
 new Globe(mapProjection.ellipsoid) The globe to use in the scene. If set to false, no globe will be added.
orderIndependentTranslucency Boolean <optional>
 true If true and the configuration supports it, use order independent translucency.
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.
dataSources DataSourceCollection <optional>
 new DataSourceCollection() The collection of data sources visualized by the widget. If this parameter is provided, the instance is assumed to be owned by the caller and will not be destroyed when the viewer is destroyed.
terrainExaggeration Number <optional>
 1.0 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 <optional>
 false Determines if shadows are cast by the sun.
terrainShadows ShadowMode <optional>
 ShadowMode.RECEIVE_ONLY Determines if the terrain casts or receives shadows from the sun.
mapMode2D MapMode2D <optional>
 MapMode2D.INFINITE_SCROLL Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
Source:
See:
Throws:
  • Element with id "container" does not exist in the document.
    Type
    DeveloperError
  • options.imageryProvider is not available when using the BaseLayerPicker widget, specify options.selectedImageryProviderViewModel instead.
    Type
    DeveloperError
  • options.terrainProvider is not available when using the BaseLayerPicker widget, specify options.selectedTerrainProviderViewModel instead.
    Type
    DeveloperError
  • options.selectedImageryProviderViewModel is not available when not using the BaseLayerPicker widget, specify options.imageryProvider instead.
    Type
    DeveloperError
  • options.selectedTerrainProviderViewModel is not available when not using the BaseLayerPicker widget, specify options.terrainProvider instead.
    Type
    DeveloperError
Example
//Initialize the viewer widget with several custom options and mixins.
var viewer = new Cesium.Viewer('cesiumContainer', {
    //Start in Columbus Viewer
    sceneMode : Cesium.SceneMode.COLUMBUS_VIEW,
    //Use standard Cesium terrain
    terrainProvider : new Cesium.CesiumTerrainProvider({
        url : 'https://assets.agi.com/stk-terrain/world'
    }),
    //Hide the base layer picker
    baseLayerPicker : false,
    //Use OpenStreetMaps
    imageryProvider : Cesium.createOpenStreetMapImageryProvider({
        url : 'https://a.tile.openstreetmap.org/'
    }),
    // 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
    mapProjection : new Cesium.WebMercatorProjection()
});

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

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

Members

allowDataSourcesToSuspendAnimation :Boolean

Gets or sets whether or not data sources can temporarily pause animation in order to avoid showing an incomplete picture to the user. For example, if asynchronous primitives are being processed in the background, the clock will not advance until the geometry is ready.
Type:
  • Boolean
Source:

(readonly) animation :Animation

Gets the Animation widget.
Type:
Source:

(readonly) baseLayerPicker :BaseLayerPicker

Gets the BaseLayerPicker.
Type:
Source:

(readonly) bottomContainer :Element

Gets the DOM element for the area at the bottom of the window containing the CreditDisplay and potentially other things.
Type:
  • Element
Source:

(readonly) camera :Camera

Gets the camera.
Type:
Source:

(readonly) canvas :Canvas

Gets the canvas.
Type:
  • Canvas
Source:
Gets the Cesium logo element.
Type:
  • Element
Source:

(readonly) cesiumWidget :CesiumWidget

Gets the CesiumWidget.
Type:
Source:

(readonly) clock :Clock

Gets the clock.
Type:
Source:

(readonly) container :Element

Gets the parent container.
Type:
  • Element
Source:

(readonly) dataSourceDisplay :DataSourceDisplay

Gets the display used for DataSource visualization.
Type:
Source:

(readonly) dataSources :DataSourceCollection

Gets the set of DataSource instances to be visualized.
Type:
Source:

(readonly) entities :EntityCollection

Gets the collection of entities not tied to a particular data source. This is a shortcut to dataSourceDisplay.defaultDataSource.entities.
Type:
Source:

(readonly) fullscreenButton :FullscreenButton

Gets the FullscreenButton.
Type:
Source:

(readonly) geocoder :Geocoder

Gets the Geocoder.
Type:
Source:

(readonly) homeButton :HomeButton

Gets the HomeButton.
Type:
Source:

(readonly) imageryLayers :ImageryLayerCollection

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

(readonly) infoBox :InfoBox

Gets the info box.
Type:
Source:
Gets the NavigationHelpButton.
Type:
Source:

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.
Type:
  • Number
Default Value:
  • 1.0
Source:

(readonly) scene :Scene

Gets the scene.
Type:
Source:

(readonly) sceneModePicker :SceneModePicker

Gets the SceneModePicker.
Type:
Source:

(readonly) screenSpaceEventHandler :ScreenSpaceEventHandler

Gets the screen space event handler.
Type:
Source:

selectedEntity :Entity

Gets or sets the object instance for which to display a selection indicator.
Type:
Source:

(readonly) selectionIndicator :SelectionIndicator

Gets the selection indicator.
Type:
Source:

(readonly) shadowMap :ShadowMap

Get the scene's shadow map
Type:
Source:

shadows :Boolean

Determines if shadows are cast by the sun.
Type:
  • Boolean
Source:

targetFrameRate :Number

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.
Type:
  • Number
Source:

terrainProvider :TerrainProvider

The terrain provider providing surface geometry for the globe.
Type:
Source:

terrainShadows :ShadowMode

Determines if the terrain casts or shadows from the sun.
Type:
  • ShadowMode
Source:

(readonly) timeline :Timeline

Gets the Timeline widget.
Type:
Source:

trackedEntity :Entity

Gets or sets the Entity instance currently being tracked by the camera.
Type:
Source:

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. 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.
Type:
  • Boolean
Source:

(readonly) vrButton :VRButton

Gets the VRButton.
Type:
Source:

Methods

destroy()

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

extend(mixin, optionsopt)

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 Attributes Description
mixin Viewer~ViewerMixin The Viewer mixin to add to this instance.
options Object <optional>
 The options object to be passed to the mixin function.
Source:
See:

flyTo(target, optionsopt) → {Promise.<Boolean>}

Flies the camera to the provided entity, entities, or data source. If the data source is still in the process of loading or the visualization is otherwise still loading, this method waits for the data to be ready before performing the flight.

The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere. The heading and the pitch angles are defined in the local east-north-up reference frame. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is zero, a range will be computed such that the whole bounding sphere is visible.

In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the target will be the range. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.

Parameters:
Name Type Attributes Description
target Entity | Array.<Entity> | EntityCollection | DataSource | ImageryLayer | Promise.<(Entity|Array.<Entity>|EntityCollection|DataSource|ImageryLayer)> The entity, array of entities, entity collection, data source or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
duration Number <optional>
 3.0 The duration of the flight in seconds.
maximumHeight Number <optional>
 The maximum height at the peak of the flight.
offset HeadingPitchRange <optional>
 The offset from the target in the local east-north-up reference frame centered at the target.
Source:
Returns:
A Promise that resolves to true if the flight was successful or false if the entity is not currently visualized in the scene or the flight was cancelled.
Type
Promise.<Boolean>

forceResize()

This forces the widget to re-think its layout, including widget sizes and credit placement.
Source:

isDestroyed() → {Boolean}

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

render()

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

resize()

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

zoomTo(target, offsetopt) → {Promise.<Boolean>}

Asynchronously sets the camera to view the provided entity, entities, or data source. If the data source is still in the process of loading or the visualization is otherwise still loading, this method waits for the data to be ready before performing the zoom.

The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere. The heading and the pitch angles are defined in the local east-north-up reference frame. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is zero, a range will be computed such that the whole bounding sphere is visible.

In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the target will be the range. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.

Parameters:
Name Type Attributes Description
target Entity | Array.<Entity> | EntityCollection | DataSource | ImageryLayer | Promise.<(Entity|Array.<Entity>|EntityCollection|DataSource|ImageryLayer)> The entity, array of entities, entity collection, data source or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.
offset HeadingPitchRange <optional>
 The offset from the center of the entity in the local east-north-up reference frame.
Source:
Returns:
A Promise that resolves to true if the zoom was successful or false if the entity is not currently visualized in the scene or the zoom was cancelled.
Type
Promise.<Boolean>

Type Definitions

ViewerMixin(viewer, options)

A function that augments a Viewer instance with additional functionality.
Parameters:
Name Type Description
viewer Viewer The viewer instance.
options Object Options object to be passed to the mixin function.
Source:
See: