Viewer (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.widgets.Viewer

```
@JsType(isNative=true,
        namespace="Cesium",
        name="Viewer")
public class Viewer
extends Object
```
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.

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Viewer.ViewerMixin
A function that augments a Viewer instance with additional functionality.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Viewer.ViewerMixin` A function that augments a Viewer instance with additional functionality.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`allowDataSourcesToSuspendAnimation` Gets or sets whether or not data sources can temporarily pause animation in order to avoid showing an incomplete picture to the user.
`Camera`	`camera` Gets the camera.
`Cesium3DTilesInspector`	`cesium3DTilesInspector`
`CesiumWidget`	`cesiumWidget` Gets the CesiumWidget.
`double`	`resolutionScale` Gets or sets a scaling factor for rendering resolution.
`Entity`	`selectedEntity` Gets or sets the object instance for which to display a selection indicator.
`boolean`	`shadows` Determines if shadows are cast by the sun.
`double`	`targetFrameRate` Gets or sets the target frame rate of the widget when useDefaultRenderLoop is true.
`TerrainProvider`	`terrainProvider` The terrain provider providing surface geometry for the globe.
`Number`	`terrainShadows` Determines if the terrain casts or shadows from the sun.
`Entity`	`trackedEntity` Gets or sets the Entity instance currently being tracked by the camera.
`boolean`	`useDefaultRenderLoop` Gets or sets whether or not this widget should control the render loop.

Constructor Summary

Constructors
Constructor and Description
`Viewer(com.google.gwt.dom.client.Element element)` A base widget for building applications.
`Viewer(com.google.gwt.dom.client.Element element, ViewerOptions options)` A base widget for building applications.
`Viewer(String element)` A base widget for building applications.
`Viewer(String element, ViewerOptions options)` A base widget for building applications.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Animation`	`animation()` Gets the Animation widget.
`BaseLayerPicker`	`baseLayerPicker()` Gets the BaseLayerPicker.
`com.google.gwt.dom.client.Element`	`bottomContainer()` Gets the DOM element for the area at the bottom of the window containing the CreditDisplay and potentially other things.
`com.google.gwt.dom.client.CanvasElement`	`canvas()` Gets the canvas.
`com.google.gwt.dom.client.Element`	`cesiumLogo()` Gets the Cesium logo element.
`Clock`	`clock()` Gets the clock.
`ClockViewModel`	`clockViewModel()` Gets the clock view model.
`com.google.gwt.dom.client.Element`	`container()` Gets the parent container.
`DataSourceDisplay`	`dataSourceDisplay()` Gets the display used for DataSource visualization.
`DataSourceCollection`	`dataSources()` Gets the set of DataSource instances to be visualized.
`void`	`destroy()` Destroys the widget.
`EntityCollection`	`entities()` Gets the collection of entities not tied to a particular data source.
`void`	`extend(Object mixin)` Extends the base viewer functionality with the provided mixin.
`void`	`extend(Object mixin, Object options)` Extends the base viewer functionality with the provided mixin.
`Promise<Boolean,Void>`	`flyTo(Object target)` Flies the camera to the provided entity, entities, or data source.
`Promise<Boolean,Void>`	`flyTo(Object target, FlyToOptions options)` Flies the camera to the provided entity, entities, or data source.
`void`	`forceResize()` This forces the widget to re-think its layout, including widget sizes and credit placement.
`FullscreenButton`	`fullscreenButton()` Gets the FullscreenButton.
`Geocoder`	`geocoder()` Gets the Geocoder.
`HomeButton`	`homeButton()` Gets the HomeButton.
`ImageryLayerCollection`	`imageryLayers()` Gets the collection of imagery layers that will be rendered on the globe.
`InfoBox`	`infoBox()` Gets the info box.
`boolean`	`isDestroyed()`
`NavigationHelpButton`	`navigationHelpButton()` Gets the NavigationHelpButton.
`ProjectionPicker`	`projectionPicker()` Gets the ProjectionPicker
`void`	`render()` Renders the scene.
`void`	`resize()` Resizes the widget to match the container size.
`Scene`	`scene()` Gets the scene.
`SceneModePicker`	`sceneModePicker()` Gets the SceneModePicker.
`ScreenSpaceEventHandler`	`screenSpaceEventHandler()` Gets the screen space event handler.
`Event`	`selectedEntityChanged()` Gets the event that is raised when the selected entity chages
`SelectionIndicator`	`selectionIndicator()` Gets the selection indicator.
`ShadowMap`	`shadowMap()` Get the scene's shadow map
`Timeline`	`timeline()` Gets the Timeline widget.
`Event`	`trackedEntityChanged()` Gets the event that is raised when the tracked entity chages
`VRButton`	`vrButton()` Gets the VRButton.
`Promise<Boolean,Void>`	`zoomTo(Cesium3DTileset target)`
`Promise<Boolean,Void>`	`zoomTo(DataSource target)`
`Promise<Boolean,Void>`	`zoomTo(Entity target)` Asynchronously sets the camera to view the provided entity, entities, or data source.
`Promise<Boolean,Void>`	`zoomTo(EntityCollection target)` Asynchronously sets the camera to view the provided entity, entities, or data source.
`Promise<Boolean,Void>`	`zoomTo(EntityCollection target, HeadingPitchRange offset)` Asynchronously sets the camera to view the provided entity, entities, or data source.
`Promise<Boolean,Void>`	`zoomTo(Object target, HeadingPitchRange offset)` Asynchronously sets the camera to view the provided entity, entities, or data source.
`Promise<Boolean,Void>`	`zoomTo(Promise<DataSource,String> target)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - allowDataSourcesToSuspendAnimation
```
@JsProperty
public boolean allowDataSourcesToSuspendAnimation
```
    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.
  - camera
```
@JsProperty
public Camera camera
```
    Gets the camera.
  - cesiumWidget
```
@JsProperty
public CesiumWidget cesiumWidget
```
    Gets the CesiumWidget.
  - resolutionScale
```
@JsProperty
public double resolutionScale
```
    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: 1.0
  - selectedEntity
```
@JsProperty
public Entity selectedEntity
```
    Gets or sets the object instance for which to display a selection indicator.
  - shadows
```
@JsProperty
public boolean shadows
```
    Determines if shadows are cast by the sun.
  - targetFrameRate
```
@JsProperty
public double targetFrameRate
```
    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
```
@JsProperty
public TerrainProvider terrainProvider
```
    The terrain provider providing surface geometry for the globe.
  - terrainShadows
```
@JsProperty
public Number terrainShadows
```
    Determines if the terrain casts or shadows from the sun.
  - trackedEntity
```
@JsProperty(name="trackedEntity")
public Entity trackedEntity
```
    Gets or sets the Entity instance currently being tracked by the camera.
  - useDefaultRenderLoop
```
@JsProperty
public boolean useDefaultRenderLoop
```
    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. Default: true
  - cesium3DTilesInspector
```
@JsProperty
public Cesium3DTilesInspector cesium3DTilesInspector
```
- Constructor Detail
  - Viewer
```
@JsConstructor
public Viewer(com.google.gwt.dom.client.Element element)
```
    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:
    
    element - The DOM element or ID that will contain the widget.
  - Viewer
```
@JsConstructor
public Viewer(String element)
```
    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:
    
    element - The DOM element or ID that will contain the widget.
  - Viewer
```
@JsConstructor
public Viewer(com.google.gwt.dom.client.Element element,
                             ViewerOptions options)
```
    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:
    
    element - The DOM element or ID that will contain the widget.
    
    options - Options.
  - Viewer
```
@JsConstructor
public Viewer(String element,
                             ViewerOptions options)
```
    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:
    
    element - The DOM element or ID that will contain the widget.
    
    options - ViewerOptions
- Method Detail
  - animation
```
@JsProperty(name="animation")
public Animation animation()
```
    Gets the Animation widget.
  - baseLayerPicker
```
@JsProperty(name="baseLayerPicker")
public BaseLayerPicker baseLayerPicker()
```
    Gets the BaseLayerPicker.
  - bottomContainer
```
@JsProperty(name="bottomContainer")
public com.google.gwt.dom.client.Element bottomContainer()
```
    Gets the DOM element for the area at the bottom of the window containing the CreditDisplay and potentially other things.
  - canvas
```
@JsProperty(name="canvas")
public com.google.gwt.dom.client.CanvasElement canvas()
```
    Gets the canvas.
  - cesiumLogo
```
@JsProperty(name="cesiumLogo")
public com.google.gwt.dom.client.Element cesiumLogo()
```
    Gets the Cesium logo element.
  - clock
```
@JsProperty(name="clock")
public Clock clock()
```
    Gets the clock.
  - clockViewModel
```
@JsProperty(name="clockViewModel")
public ClockViewModel clockViewModel()
```
    Gets the clock view model.
    
    Returns:
    
    clock view model.
  - container
```
@JsProperty(name="container")
public com.google.gwt.dom.client.Element container()
```
    Gets the parent container.
  - dataSourceDisplay
```
@JsProperty(name="dataSourceDisplay")
public DataSourceDisplay dataSourceDisplay()
```
    Gets the display used for DataSource visualization.
  - dataSources
```
@JsProperty(name="dataSources")
public DataSourceCollection dataSources()
```
    Gets the set of DataSource instances to be visualized.
  - entities
```
@JsProperty(name="entities")
public EntityCollection entities()
```
    Gets the collection of entities not tied to a particular data source. This is a shortcut to dataSourceDisplay.defaultDataSource.entities.
  - fullscreenButton
```
@JsProperty(name="fullscreenButton")
public FullscreenButton fullscreenButton()
```
    Gets the FullscreenButton.
  - geocoder
```
@JsProperty(name="geocoder")
public Geocoder geocoder()
```
    Gets the Geocoder.
  - homeButton
```
@JsProperty(name="homeButton")
public HomeButton homeButton()
```
    Gets the HomeButton.
  - imageryLayers
```
@JsProperty(name="imageryLayers")
public ImageryLayerCollection imageryLayers()
```
    Gets the collection of imagery layers that will be rendered on the globe.
  - infoBox
```
@JsProperty(name="infoBox")
public InfoBox infoBox()
```
    Gets the info box.
  - navigationHelpButton
```
@JsProperty(name="navigationHelpButton")
public NavigationHelpButton navigationHelpButton()
```
    Gets the NavigationHelpButton.
  - projectionPicker
```
@JsProperty(name="projectionPicker")
public ProjectionPicker projectionPicker()
```
    Gets the ProjectionPicker
  - scene
```
@JsProperty(name="scene")
public Scene scene()
```
    Gets the scene.
  - sceneModePicker
```
@JsProperty(name="sceneModePicker")
public SceneModePicker sceneModePicker()
```
    Gets the SceneModePicker.
  - screenSpaceEventHandler
```
@JsProperty(name="screenSpaceEventHandler")
public ScreenSpaceEventHandler screenSpaceEventHandler()
```
    Gets the screen space event handler.
  - selectedEntityChanged
```
@JsProperty(name="selectedEntityChanged")
public Event selectedEntityChanged()
```
    Gets the event that is raised when the selected entity chages
  - selectionIndicator
```
@JsProperty(name="selectionIndicator")
public SelectionIndicator selectionIndicator()
```
    Gets the selection indicator.
  - shadowMap
```
@JsProperty(name="shadowMap")
public ShadowMap shadowMap()
```
    Get the scene's shadow map
  - timeline
```
@JsProperty(name="timeline")
public Timeline timeline()
```
    Gets the Timeline widget.
  - trackedEntityChanged
```
@JsProperty(name="trackedEntityChanged")
public Event trackedEntityChanged()
```
    Gets the event that is raised when the tracked entity chages
    
    Returns:
    
    get event for change tracked entity.
  - vrButton
```
@JsProperty(name="vrButton")
public VRButton vrButton()
```
    Gets the VRButton.
  - destroy
```
@JsMethod
public void destroy()
```
    Destroys the widget. Should be called if permanently removing the widget from layout.
  - extend
```
@JsMethod
public void extend(Object mixin)
```
    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:
    
    mixin - The Viewer mixin to add to this instance.
  - extend
```
@JsMethod
public void extend(Object mixin,
                             Object options)
```
    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:
    
    mixin - The Viewer mixin to add to this instance.
    
    options - The options object to be passed to the mixin function.
  - flyTo
```
@JsMethod
public Promise<Boolean,Void> flyTo(Object target)
```
    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:
    
    target - 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.
    
    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.
  - flyTo
```
@JsMethod
public Promise<Boolean,Void> flyTo(Object target,
                                             FlyToOptions options)
```
    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:
    
    target - 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 - Options.
    
    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.
  - forceResize
```
@JsMethod
public void forceResize()
```
    This forces the widget to re-think its layout, including widget sizes and credit placement.
  - isDestroyed
```
@JsMethod
public boolean isDestroyed()
```
    Returns:
    
    true if the object has been destroyed, false otherwise.
  - render
```
@JsMethod
public void render()
```
    Renders the scene. This function is called automatically unless useDefaultRenderLoop is set to false;
  - resize
```
@JsMethod
public void resize()
```
    Resizes the widget to match the container size. This function is called automatically as needed unless useDefaultRenderLoop is set to false.
  - zoomTo
```
@JsMethod
public Promise<Boolean,Void> zoomTo(EntityCollection target)
```
    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:
    
    target - 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.
    
    Returns:
    
    ready promise for EntityCollection
  - zoomTo
```
@JsMethod
public Promise<Boolean,Void> zoomTo(Entity target)
```
    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:
    
    target - 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.
    
    Returns:
    
    ready promise for Entity
  - zoomTo
```
@JsMethod
public Promise<Boolean,Void> zoomTo(Promise<DataSource,String> target)
```
  - zoomTo
```
@JsMethod
public Promise<Boolean,Void> zoomTo(DataSource target)
```
  - zoomTo
```
@JsMethod
public Promise<Boolean,Void> zoomTo(Cesium3DTileset target)
```
  - zoomTo
```
@JsMethod
public Promise<Boolean,Void> zoomTo(EntityCollection target,
                                              HeadingPitchRange offset)
```
    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:
    
    target - 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 - The offset from the center of the entity in the local east-north-up reference frame.
    
    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.
  - zoomTo
```
@JsMethod
public Promise<Boolean,Void> zoomTo(Object target,
                                              HeadingPitchRange offset)
```
    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:
    
    target - 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 - The offset from the center of the entity in the local east-north-up reference frame.
    
    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.

Class Viewer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

allowDataSourcesToSuspendAnimation

camera

cesiumWidget

resolutionScale

selectedEntity

shadows

targetFrameRate

terrainProvider

terrainShadows

trackedEntity

useDefaultRenderLoop

cesium3DTilesInspector

Constructor Detail

Viewer

Viewer

Viewer

Viewer

Method Detail

animation

baseLayerPicker

bottomContainer

canvas

cesiumLogo

clock

clockViewModel

container

dataSourceDisplay

dataSources

entities

fullscreenButton

geocoder

homeButton

imageryLayers

infoBox

navigationHelpButton

projectionPicker

scene

sceneModePicker

screenSpaceEventHandler

selectedEntityChanged

selectionIndicator

shadowMap

timeline

trackedEntityChanged

vrButton

destroy

extend

extend

flyTo

flyTo

forceResize

isDestroyed

render

resize

zoomTo

zoomTo

zoomTo

zoomTo

zoomTo

zoomTo

zoomTo