ViewerOptions (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.widgets.options.ViewerOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class ViewerOptions
extends Object

Author:: Serge Silaev aka iSergio

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`animation` If set to false, the Animation widget will not be created.
`boolean`	`automaticallyTrackDataSourceClocks` If true, this widget will automatically track the clock settings of newly added DataSources, updating if the DataSource's clock changes.
`boolean`	`baseLayerPicker` If set to false, the BaseLayerPicker widget will not be created.
`ClockViewModel`	`clockViewModel` The clock view model to use to control current time.
`Object`	`contextOptions` Context and WebGL creation properties corresponding to options passed to Scene.
`com.google.gwt.dom.client.Element`	`creditContainer` The DOM element or ID that will contain the CreditDisplay.
`DataSourceCollection`	`dataSources` The collection of data sources visualized by the widget.
`boolean`	`fullscreenButton` If set to false, the FullscreenButton widget will not be created.
`com.google.gwt.dom.client.Element`	`fullscreenElement` The element or id to be placed into fullscreen mode when the full screen button is pressed.
`boolean`	`geocoder` If set to false, the Geocoder widget will not be created.
`GeocoderService[]`	`geocoderServices`
`Globe`	`globe` The globe to use in the scene.
`boolean`	`homeButton` If set to false, the HomeButton widget will not be created.
`ImageryProvider`	`imageryProvider` The imagery provider to use.
`ProviderViewModel[]`	`imageryProviderViewModels` The array of ProviderViewModels to be selectable from the BaseLayerPicker.
`boolean`	`infoBox` If set to false, the InfoBox widget will not be created.
`int`	`mapMode2D` Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
`MapProjection`	`mapProjection` The map projection to use in 2D and Columbus View modes.
`boolean`	`navigationHelpButton` If set to false, the navigation help button will not be created.
`boolean`	`navigationInstructionsInitiallyVisible` True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button.
`boolean`	`orderIndependentTranslucency` If true and the configuration supports it, use order independent translucency.
`boolean`	`projectionPicker` If set to true, the ProjectionPicker widget will be created.
`boolean`	`requestRenderMode` If true, rendering a frame will only occur when needed as determined by changes within the scene.
`boolean`	`scene3DOnly` When true, each geometry instance will only be rendered in 3D to save GPU memory.
`Number`	`sceneMode` SceneMode SceneMode.SCENE3D optional The initial scene mode.
`boolean`	`sceneModePicker` If set to false, the SceneModePicker widget will not be created.
`ProviderViewModel`	`selectedImageryProviderViewModel` The view model for the current base imagery layer, if not supplied the first available base layer is used.
`ProviderViewModel`	`selectedTerrainProviderViewModel` The view model for the current base terrain layer, if not supplied the first available base layer is used.
`boolean`	`selectionIndicator` If set to false, the SelectionIndicator widget will not be created.
`boolean`	`shadows` Determines if shadows are cast by the sun.
`boolean`	`shouldAnimate` if the clock should attempt to advance simulation time by default, false otherwise.
`boolean`	`showRenderLoopErrors` If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.
`SkyAtmosphere`	`skyAtmosphere` Blue sky, and the glow around the Earth's limb.
`SkyBox`	`skyBox` The skybox used to render the stars.
`double`	`targetFrameRate` The target frame rate when using the default render loop.
`double`	`terrainExaggeration` A scalar used to exaggerate the terrain.
`TerrainProvider`	`terrainProvider` The terrain provider to use Default: new EllipsoidTerrainProvider()
`ProviderViewModel[]`	`terrainProviderViewModels` The array of ProviderViewModels to be selectable from the BaseLayerPicker.
`Number`	`terrainShadows` Determines if the terrain casts or receives shadows from the sun.
`boolean`	`timeline` If set to false, the Timeline widget will not be created.
`boolean`	`useDefaultRenderLoop` True if this widget should control the render loop, false otherwise.
`boolean`	`vrButton` If set to true, the VRButton widget will be created.

Constructor Summary

Constructors
Constructor and Description

ViewerOptions()

Constructors
Constructor and Description
`ViewerOptions()`

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

- Field Detail
  - animation
```
@JsProperty
public boolean animation
```
    If set to false, the Animation widget will not be created. Default: true.
  - baseLayerPicker
```
@JsProperty
public boolean baseLayerPicker
```
    If set to false, the BaseLayerPicker widget will not be created. Default: true.
  - fullscreenButton
```
@JsProperty
public boolean fullscreenButton
```
    If set to false, the FullscreenButton widget will not be created. Default: true.
  - vrButton
```
@JsProperty
public boolean vrButton
```
    If set to true, the VRButton widget will be created. Default: false.
  - geocoder
```
@JsProperty
public boolean geocoder
```
    If set to false, the Geocoder widget will not be created. Default: true.
  - geocoderServices
```
@JsProperty(name="geocoder")
public GeocoderService[] geocoderServices
```
  - homeButton
```
@JsProperty
public boolean homeButton
```
    If set to false, the HomeButton widget will not be created. Default: true.
  - infoBox
```
@JsProperty
public boolean infoBox
```
    If set to false, the InfoBox widget will not be created. Default: true.
  - sceneModePicker
```
@JsProperty
public boolean sceneModePicker
```
    If set to false, the SceneModePicker widget will not be created. Default: true.
  - selectionIndicator
```
@JsProperty
public boolean selectionIndicator
```
    If set to false, the SelectionIndicator widget will not be created. Default: true.
  - timeline
```
@JsProperty
public boolean timeline
```
    If set to false, the Timeline widget will not be created. Default: true.
  - navigationHelpButton
```
@JsProperty
public boolean navigationHelpButton
```
    If set to false, the navigation help button will not be created. Default: true.
  - navigationInstructionsInitiallyVisible
```
@JsProperty
public boolean navigationInstructionsInitiallyVisible
```
    True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button. Default: true.
  - scene3DOnly
```
@JsProperty
public boolean scene3DOnly
```
    When true, each geometry instance will only be rendered in 3D to save GPU memory. Default: false.
  - shouldAnimate
```
@JsProperty
public boolean shouldAnimate
```
    if the clock should attempt to advance simulation time by default, false otherwise. This option takes precedence over setting Viewer.clockViewModel(). Default: false
  - clockViewModel
```
@JsProperty
public ClockViewModel clockViewModel
```
    The clock view model to use to control current time. Optional. Default: new ClockViewModel(options.clock)
  - selectedImageryProviderViewModel
```
@JsProperty
public ProviderViewModel selectedImageryProviderViewModel
```
    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
```
@JsProperty
public ProviderViewModel[] imageryProviderViewModels
```
    The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true. Default: createDefaultImageryProviderViewModels()
  - selectedTerrainProviderViewModel
```
@JsProperty
public ProviderViewModel selectedTerrainProviderViewModel
```
    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
```
@JsProperty
public ProviderViewModel[] terrainProviderViewModels
```
    The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if options.baseLayerPicker is set to true. Default: createDefaultTerrainProviderViewModels()
  - imageryProvider
```
@JsProperty
public ImageryProvider imageryProvider
```
    The imagery provider to use. This value is only valid if options.baseLayerPicker is set to false. Default: new BingMapsImageryProvider()
  - terrainProvider
```
@JsProperty
public TerrainProvider terrainProvider
```
    The terrain provider to use Default: new EllipsoidTerrainProvider()
  - skyBox
```
@JsProperty
public SkyBox skyBox
```
    The skybox used to render the stars. When undefined, the default stars are used.
  - skyAtmosphere
```
@JsProperty
public SkyAtmosphere skyAtmosphere
```
    Blue sky, and the glow around the Earth's limb. Set to false to turn it off.
  - fullscreenElement
```
@JsProperty
public com.google.gwt.dom.client.Element fullscreenElement
```
    The element or id to be placed into fullscreen mode when the full screen button is pressed. Default: document.body
  - useDefaultRenderLoop
```
@JsProperty
public boolean useDefaultRenderLoop
```
    True if this widget should control the render loop, false otherwise. Default: true
  - targetFrameRate
```
@JsProperty
public double targetFrameRate
```
    The target frame rate when using the default render loop.
  - showRenderLoopErrors
```
@JsProperty
public boolean showRenderLoopErrors
```
    If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs. Default: true
  - automaticallyTrackDataSourceClocks
```
@JsProperty
public boolean automaticallyTrackDataSourceClocks
```
    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
```
@JsProperty
public Object contextOptions
```
    Context and WebGL creation properties corresponding to options passed to Scene.
  - sceneMode
```
@JsProperty
public Number sceneMode
```
    SceneMode SceneMode.SCENE3D optional The initial scene mode. Default: SceneMode.SCENE3D()
  - mapProjection
```
@JsProperty
public MapProjection mapProjection
```
    The map projection to use in 2D and Columbus View modes. Default: new GeographicProjection()
  - globe
```
@JsProperty
public Globe globe
```
    The globe to use in the scene. If set to false, no globe will be added. Default: new Globe(mapProjection.ellipsoid)
  - orderIndependentTranslucency
```
@JsProperty
public boolean orderIndependentTranslucency
```
    If true and the configuration supports it, use order independent translucency. Default: true
  - creditContainer
```
@JsProperty
public com.google.gwt.dom.client.Element creditContainer
```
    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
```
@JsProperty
public DataSourceCollection dataSources
```
    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. Default: new DataSourceCollection()
  - terrainExaggeration
```
@JsProperty
public double terrainExaggeration
```
    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. Default: 1.0
  - shadows
```
@JsProperty
public boolean shadows
```
    Determines if shadows are cast by the sun.
  - terrainShadows
```
@JsProperty
public Number terrainShadows
```
    Determines if the terrain casts or receives shadows from the sun. Default: ShadowMode.RECEIVE_ONLY()
  - mapMode2D
```
@JsProperty
public int mapMode2D
```
    Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. Default: MapMode2D.INFINITE_SCROLL()
  - projectionPicker
```
@JsProperty
public boolean projectionPicker
```
    If set to true, the ProjectionPicker widget will be created. Default: false
  - requestRenderMode
```
@JsProperty
public boolean requestRenderMode
```
    If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using Scene.requestRender() to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API. See Improving Performance with Explicit Rendering. Default: false
- Constructor Detail
  - ViewerOptions
```
@JsConstructor
public ViewerOptions()
```

Class ViewerOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

animation

baseLayerPicker

fullscreenButton

vrButton

geocoder

geocoderServices

homeButton

infoBox

sceneModePicker

selectionIndicator

timeline

navigationHelpButton

navigationInstructionsInitiallyVisible

scene3DOnly

shouldAnimate

clockViewModel

selectedImageryProviderViewModel

imageryProviderViewModels

selectedTerrainProviderViewModel

terrainProviderViewModels

imageryProvider

terrainProvider

skyBox

skyAtmosphere

fullscreenElement

useDefaultRenderLoop

targetFrameRate

showRenderLoopErrors

automaticallyTrackDataSourceClocks

contextOptions

sceneMode

mapProjection

globe

orderIndependentTranslucency

creditContainer

dataSources

terrainExaggeration

shadows

terrainShadows

mapMode2D

projectionPicker

requestRenderMode

Constructor Detail

ViewerOptions