ConstructorOptions
Initialization options for the Viewer constructor
See also
Properties
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. Default value - true
The bottommost imagery layer applied to the globe. If set to false, no imagery provider will be added. This value is only valid if baseLayerPicker is set to false. Default value - ImageryLayer.fromWorldImagery()
If set to false, the BaseLayerPicker widget will not be created. Default value - true
If true, the active element will blur when the viewer's canvas is clicked. Setting this to false is useful for cases when the canvas is clicked only for retrieving position or an entity data without actually meaning to set the canvas to be the active element. Default value - true
The clock view model to use to control current time. Default value - ClockViewModel(clock)
Context and WebGL creation properties passed to Scene.
The DOM element that will contain the CreditDisplay. If not specified, the credits are added to the bottom of the widget itself.
The DOM element that will contain the credit pop up created by the CreditDisplay. If not specified, it will appear over the widget itself.
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 value - DataSourceCollection()
Adjust the DepthPlane to address rendering artefacts below ellipsoid zero elevation. Default value - 0.0
The default ellipsoid. Default value - Ellipsoid.default
If set to false, the FullscreenButton widget will not be created. Default value - true
The element or id to be placed into fullscreen mode when the full screen button is pressed. Default value - document.body
The globe to use in the scene. If set to false, no globe will be added and the sky atmosphere will be hidden by default. Default value - Globe(options.ellipsoid)
If set to false, the HomeButton widget will not be created. Default value - true
The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if baseLayerPicker is set to true. Default value - createDefaultImageryProviderViewModels()
Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction. Default value - MapMode2D.INFINITE_SCROLL
The map projection to use in 2D and Columbus View modes. Default value - GeographicProjection(options.ellipsoid)
If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See Improving Performance with Explicit Rendering. Default value - 0.0
If provided, this value controls the rate of multisample antialiasing. Typical multisampling rates are 2, 4, and sometimes 8 samples per pixel. Higher sampling rates of MSAA may impact performance in exchange for improved visual quality. This value only applies to WebGL2 contexts that support multisample render targets. Set to 1 to disable MSAA. Default value - 4
If set to false, the navigation help button will not be created. Default value - 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. Default value - true
If true and the configuration supports it, use order independent translucency. Default value - true
If set to true, the ProjectionPicker widget will be created. Default value - false
If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling reduces the CPU/GPU usage of your application and uses less battery on mobile, 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 value - false
When true, each geometry instance will only be rendered in 3D to save GPU memory. Default value - false
The initial scene mode. Default value - SceneMode.SCENE3D
If set to false, the SceneModePicker widget will not be created. Default value - true
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 baseLayerPicker is set to true.
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 baseLayerPicker is set to true.
If set to false, the SelectionIndicator widget will not be created. Default value - true
true if the clock should attempt to advance simulation time by default, false otherwise. This option takes precedence over setting Viewer.clockViewModel. Default value - false
If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs. Default value - true
Blue sky, and the glow around the Earth's limb. Enabled when the WGS84 ellipsoid used. Set to false to turn it off.
The target frame rate when using the default render loop.
The terrain provider to use Default value - EllipsoidTerrainProvider()
The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if baseLayerPicker is set to true. Default value - createDefaultTerrainProviderViewModels()
Determines if the terrain casts or receives shadows from light sources. Default value - ShadowMode.RECEIVE_ONLY
If true, render at the browser's recommended resolution and ignore window.devicePixelRatio. Default value - true
True if this widget should control the render loop, false otherwise. Default value - true