wuhongjian
/
qd-changjing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qd-changjing/public/static/Build/Documentation/Viewer.html

5849 lines
135 KiB
HTML
Raw Normal View History

first commit
2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Viewer - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
Viewer
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="Viewer">
<a href="#Viewer" class="doc-link"></a>
new Cesium.Viewer<span class="signature">(container, <span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L405">Widgets/Viewer/Viewer.js 405</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>container</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">String</span>
</td>
<td class="description last">
The DOM element or ID that will contain the widget.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type"><a href="Viewer.html#.ConstructorOptions">Viewer.ConstructorOptions</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object describing initialization options</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: Element with id "container" does not exist in the document.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: options.selectedImageryProviderViewModel is not available when not using the BaseLayerPicker widget, specify options.imageryProvider instead.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: options.selectedTerrainProviderViewModel is not available when not using the BaseLayerPicker widget, specify options.terrainProvider instead.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">//Initialize the viewer widget with several custom options and mixins.
const viewer = new Cesium.Viewer('cesiumContainer', {
//Start in Columbus Viewer
sceneMode : Cesium.SceneMode.COLUMBUS_VIEW,
//Use Cesium World Terrain
terrainProvider : Cesium.createWorldTerrain(),
//Hide the base layer picker
baseLayerPicker : false,
//Use OpenStreetMaps
imageryProvider : new Cesium.OpenStreetMapImageryProvider({
url : 'https://a.tile.openstreetmap.org/'
}),
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);
});</code></pre>
<h5>Demo:</h5>
<ul class="see-list">
<li><a href="https://sandcastle.cesium.com/index.html?src=Hello%2520World.html">Cesium Sandcastle Hello World Demo</a></li>
</ul>
<h5>See:</h5>
<ul class="see-list">
<li><a href="Animation.html">Animation</a></li>
<li><a href="BaseLayerPicker.html">BaseLayerPicker</a></li>
<li><a href="CesiumWidget.html">CesiumWidget</a></li>
<li><a href="FullscreenButton.html">FullscreenButton</a></li>
<li><a href="HomeButton.html">HomeButton</a></li>
<li><a href="SceneModePicker.html">SceneModePicker</a></li>
<li><a href="Timeline.html">Timeline</a></li>
<li><a href="global.html#viewerDragDropMixin">viewerDragDropMixin</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="allowDataSourcesToSuspendAnimation">
<a href="#allowDataSourcesToSuspendAnimation" class="doc-link"></a>
allowDataSourcesToSuspendAnimation<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1399">Widgets/Viewer/Viewer.js 1399</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="animation">
<a href="#animation" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> animation<span class="type-signature"> : <a href="Animation.html">Animation</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1073">Widgets/Viewer/Viewer.js 1073</a>
</div>
</h4>
</div>
<div class="description">
Gets the Animation widget.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="baseLayerPicker">
<a href="#baseLayerPicker" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> baseLayerPicker<span class="type-signature"> : <a href="BaseLayerPicker.html">BaseLayerPicker</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1049">Widgets/Viewer/Viewer.js 1049</a>
</div>
</h4>
</div>
<div class="description">
Gets the BaseLayerPicker.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="bottomContainer">
<a href="#bottomContainer" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> bottomContainer<span class="type-signature"> : Element</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L953">Widgets/Viewer/Viewer.js 953</a>
</div>
</h4>
</div>
<div class="description">
Gets the DOM element for the area at the bottom of the window containing the
<a href="CreditDisplay.html"><code>CreditDisplay</code></a> and potentially other things.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="camera">
<a href="#camera" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> camera<span class="type-signature"> : <a href="Camera.html">Camera</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1251">Widgets/Viewer/Viewer.js 1251</a>
</div>
</h4>
</div>
<div class="description">
Gets the camera.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="canvas">
<a href="#canvas" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> canvas<span class="type-signature"> : HTMLCanvasElement</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1158">Widgets/Viewer/Viewer.js 1158</a>
</div>
</h4>
</div>
<div class="description">
Gets the canvas.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="cesiumWidget">
<a href="#cesiumWidget" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> cesiumWidget<span class="type-signature"> : <a href="CesiumWidget.html">CesiumWidget</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L965">Widgets/Viewer/Viewer.js 965</a>
</div>
</h4>
</div>
<div class="description">
Gets the CesiumWidget.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clock">
<a href="#clock" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> clock<span class="type-signature"> : <a href="Clock.html">Clock</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1276">Widgets/Viewer/Viewer.js 1276</a>
</div>
</h4>
</div>
<div class="description">
Gets the clock.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clockTrackedDataSource">
<a href="#clockTrackedDataSource" class="doc-link"></a>
clockTrackedDataSource<span class="type-signature"> : <a href="DataSource.html">DataSource</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1515">Widgets/Viewer/Viewer.js 1515</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the data source to track with the viewer's clock.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="clockViewModel">
<a href="#clockViewModel" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> clockViewModel<span class="type-signature"> : <a href="ClockViewModel.html">ClockViewModel</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1288">Widgets/Viewer/Viewer.js 1288</a>
</div>
</h4>
</div>
<div class="description">
Gets the clock view model.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="container">
<a href="#container" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> container<span class="type-signature"> : Element</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L940">Widgets/Viewer/Viewer.js 940</a>
</div>
</h4>
</div>
<div class="description">
Gets the parent container.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="dataSourceDisplay">
<a href="#dataSourceDisplay" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> dataSourceDisplay<span class="type-signature"> : <a href="DataSourceDisplay.html">DataSourceDisplay</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1121">Widgets/Viewer/Viewer.js 1121</a>
</div>
</h4>
</div>
<div class="description">
Gets the display used for <a href="DataSource.html"><code>DataSource</code></a> visualization.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="dataSources">
<a href="#dataSources" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> dataSources<span class="type-signature"> : <a href="DataSourceCollection.html">DataSourceCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1146">Widgets/Viewer/Viewer.js 1146</a>
</div>
</h4>
</div>
<div class="description">
Gets the set of <a href="DataSource.html"><code>DataSource</code></a> instances to be visualized.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="entities">
<a href="#entities" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> entities<span class="type-signature"> : <a href="EntityCollection.html">EntityCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1134">Widgets/Viewer/Viewer.js 1134</a>
</div>
</h4>
</div>
<div class="description">
Gets the collection of entities not tied to a particular data source.
This is a shortcut to <a href="Viewer.html#dataSourceDisplay"><code>dataSourceDisplay.defaultDataSource.entities</code></a>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="fullscreenButton">
<a href="#fullscreenButton" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> fullscreenButton<span class="type-signature"> : <a href="FullscreenButton.html">FullscreenButton</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1097">Widgets/Viewer/Viewer.js 1097</a>
</div>
</h4>
</div>
<div class="description">
Gets the FullscreenButton.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="geocoder">
<a href="#geocoder" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> geocoder<span class="type-signature"> : <a href="Geocoder.html">Geocoder</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1001">Widgets/Viewer/Viewer.js 1001</a>
</div>
</h4>
</div>
<div class="description">
Gets the Geocoder.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="homeButton">
<a href="#homeButton" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> homeButton<span class="type-signature"> : <a href="HomeButton.html">HomeButton</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1013">Widgets/Viewer/Viewer.js 1013</a>
</div>
</h4>
</div>
<div class="description">
Gets the HomeButton.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="imageryLayers">
<a href="#imageryLayers" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> imageryLayers<span class="type-signature"> : <a href="ImageryLayerCollection.html">ImageryLayerCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1223">Widgets/Viewer/Viewer.js 1223</a>
</div>
</h4>
</div>
<div class="description">
Gets the collection of image layers that will be rendered on the globe.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="infoBox">
<a href="#infoBox" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> infoBox<span class="type-signature"> : <a href="InfoBox.html">InfoBox</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L989">Widgets/Viewer/Viewer.js 989</a>
</div>
</h4>
</div>
<div class="description">
Gets the info box.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="navigationHelpButton">
<a href="#navigationHelpButton" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> navigationHelpButton<span class="type-signature"> : <a href="NavigationHelpButton.html">NavigationHelpButton</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1061">Widgets/Viewer/Viewer.js 1061</a>
</div>
</h4>
</div>
<div class="description">
Gets the NavigationHelpButton.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="postProcessStages">
<a href="#postProcessStages" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> postProcessStages<span class="type-signature"> : <a href="PostProcessStageCollection.html">PostProcessStageCollection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1264">Widgets/Viewer/Viewer.js 1264</a>
</div>
</h4>
</div>
<div class="description">
Gets the post-process stages.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="projectionPicker">
<a href="#projectionPicker" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> projectionPicker<span class="type-signature"> : <a href="ProjectionPicker.html">ProjectionPicker</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1037">Widgets/Viewer/Viewer.js 1037</a>
</div>
</h4>
</div>
<div class="description">
Gets the ProjectionPicker.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="resolutionScale">
<a href="#resolutionScale" class="doc-link"></a>
resolutionScale<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1359">Widgets/Viewer/Viewer.js 1359</a>
</div>
</h4>
</div>
<div class="description">
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.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="scene">
<a href="#scene" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> scene<span class="type-signature"> : <a href="Scene.html">Scene</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1170">Widgets/Viewer/Viewer.js 1170</a>
</div>
</h4>
</div>
<div class="description">
Gets the scene.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="sceneModePicker">
<a href="#sceneModePicker" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> sceneModePicker<span class="type-signature"> : <a href="SceneModePicker.html">SceneModePicker</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1025">Widgets/Viewer/Viewer.js 1025</a>
</div>
</h4>
</div>
<div class="description">
Gets the SceneModePicker.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="screenSpaceEventHandler">
<a href="#screenSpaceEventHandler" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> screenSpaceEventHandler<span class="type-signature"> : <a href="ScreenSpaceEventHandler.html">ScreenSpaceEventHandler</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1300">Widgets/Viewer/Viewer.js 1300</a>
</div>
</h4>
</div>
<div class="description">
Gets the screen space event handler.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="selectedEntity">
<a href="#selectedEntity" class="doc-link"></a>
selectedEntity<span class="type-signature"> : <a href="Entity.html">Entity</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1466">Widgets/Viewer/Viewer.js 1466</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the object instance for which to display a selection indicator.
If a user interactively picks a Cesium3DTilesFeature instance, then this property
will contain a transient Entity instance with a property named "feature" that is
the instance that was picked.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="selectedEntityChanged">
<a href="#selectedEntityChanged" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> selectedEntityChanged<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1494">Widgets/Viewer/Viewer.js 1494</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that is raised when the selected entity changes.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="selectionIndicator">
<a href="#selectionIndicator" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> selectionIndicator<span class="type-signature"> : <a href="SelectionIndicator.html">SelectionIndicator</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L977">Widgets/Viewer/Viewer.js 977</a>
</div>
</h4>
</div>
<div class="description">
Gets the selection indicator.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="shadowMap">
<a href="#shadowMap" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> shadowMap<span class="type-signature"> : <a href="ShadowMap.html">ShadowMap</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1210">Widgets/Viewer/Viewer.js 1210</a>
</div>
</h4>
</div>
<div class="description">
Get the scene's shadow map
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="shadows">
<a href="#shadows" class="doc-link"></a>
shadows<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1181">Widgets/Viewer/Viewer.js 1181</a>
</div>
</h4>
</div>
<div class="description">
Determines if shadows are cast by light sources.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="targetFrameRate">
<a href="#targetFrameRate" class="doc-link"></a>
targetFrameRate<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1315">Widgets/Viewer/Viewer.js 1315</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the target frame rate of the widget when <code>useDefaultRenderLoop</code>
is true. If undefined, the browser's <a href="global.html#requestAnimationFrame"><code>requestAnimationFrame</code></a> 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.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="terrainProvider">
<a href="#terrainProvider" class="doc-link"></a>
terrainProvider<span class="type-signature"> : <a href="TerrainProvider.html">TerrainProvider</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1235">Widgets/Viewer/Viewer.js 1235</a>
</div>
</h4>
</div>
<div class="description">
The terrain provider providing surface geometry for the globe.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="terrainShadows">
<a href="#terrainShadows" class="doc-link"></a>
terrainShadows<span class="type-signature"> : <a href="global.html#ShadowMode">ShadowMode</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1195">Widgets/Viewer/Viewer.js 1195</a>
</div>
</h4>
</div>
<div class="description">
Determines if the terrain casts or shadows from light sources.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="timeline">
<a href="#timeline" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> timeline<span class="type-signature"> : <a href="Timeline.html">Timeline</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1085">Widgets/Viewer/Viewer.js 1085</a>
</div>
</h4>
</div>
<div class="description">
Gets the Timeline widget.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="trackedEntity">
<a href="#trackedEntity" class="doc-link"></a>
trackedEntity<span class="type-signature"> : <a href="Entity.html">Entity</a>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1413">Widgets/Viewer/Viewer.js 1413</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the Entity instance currently being tracked by the camera.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="trackedEntityChanged">
<a href="#trackedEntityChanged" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> trackedEntityChanged<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1505">Widgets/Viewer/Viewer.js 1505</a>
</div>
</h4>
</div>
<div class="description">
Gets the event that is raised when the tracked entity changes.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="useBrowserRecommendedResolution">
<a href="#useBrowserRecommendedResolution" class="doc-link"></a>
useBrowserRecommendedResolution<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1380">Widgets/Viewer/Viewer.js 1380</a>
</div>
</h4>
</div>
<div class="description">
Boolean flag indicating if the browser's recommended resolution is used.
If true, the browser's device pixel ratio is ignored and 1.0 is used instead,
effectively rendering based on CSS pixels instead of device pixels. This can improve
performance on less powerful devices that have high pixel density. When false, rendering
will be in device pixels. <a href="Viewer.html#resolutionScale"><code>Viewer#resolutionScale</code></a> will still take effect whether
this flag is true or false.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">true</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="useDefaultRenderLoop">
<a href="#useDefaultRenderLoop" class="doc-link"></a>
useDefaultRenderLoop<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1338">Widgets/Viewer/Viewer.js 1338</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets whether or not this widget should control the render loop.
If set to true the widget will use <a href="global.html#requestAnimationFrame"><code>requestAnimationFrame</code></a> to
perform rendering and resizing of the widget, as well as drive the
simulation clock. If set to false, you must manually call the
<code>resize</code>, <code>render</code> methods
as part of a custom render loop. If an error occurs during rendering, <a href="Scene.html"><code>Scene</code></a>'s
<code>renderError</code> 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.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="vrButton">
<a href="#vrButton" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> vrButton<span class="type-signature"> : <a href="VRButton.html">VRButton</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1109">Widgets/Viewer/Viewer.js 1109</a>
</div>
</h4>
</div>
<div class="description">
Gets the VRButton.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="destroy">
<a href="#destroy" class="doc-link"></a>
destroy<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1679">Widgets/Viewer/Viewer.js 1679</a>
</div>
</h4>
</div>
<div class="description">
Destroys the widget. Should be called if permanently
removing the widget from layout.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="extend">
<a href="#extend" class="doc-link"></a>
extend<span class="signature">(mixin, <span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1538">Widgets/Viewer/Viewer.js 1538</a>
</div>
</h4>
</div>
<div class="description">
Extends the base viewer functionality with the provided mixin.
A mixin may add additional properties, functions, or other behavior
to the provided viewer instance.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>mixin</code></td>
<td class="type">
<span class="param-type"><a href="Viewer.html#.ViewerMixin">Viewer.ViewerMixin</a></span>
</td>
<td class="description last">
The Viewer mixin to add to this instance.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The options object to be passed to the mixin function.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="global.html#viewerDragDropMixin">viewerDragDropMixin</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="flyTo">
<a href="#flyTo" class="doc-link"></a>
flyTo<span class="signature">(target, <span class="optional">options</span>)</span> &rarr; <span class="type-signature returnType">Promise.&lt;Boolean></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L2063">Widgets/Viewer/Viewer.js 2063</a>
</div>
</h4>
</div>
<div class="description">
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.
<p>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.</p>
<p>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.</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type"><a href="Entity.html">Entity</a></span>
|
<span class="param-type">Array.&lt;<a href="Entity.html">Entity</a>></span>
|
<span class="param-type"><a href="EntityCollection.html">EntityCollection</a></span>
|
<span class="param-type"><a href="DataSource.html">DataSource</a></span>
|
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
|
<span class="param-type"><a href="Cesium3DTileset.html">Cesium3DTileset</a></span>
|
<span class="param-type"><a href="TimeDynamicPointCloud.html">TimeDynamicPointCloud</a></span>
|
<span class="param-type">Promise.&lt;(<a href="Entity.html">Entity</a>|Array.&lt;<a href="Entity.html">Entity</a>>|<a href="EntityCollection.html">EntityCollection</a>|<a href="DataSource.html">DataSource</a>|<a href="ImageryLayer.html">ImageryLayer</a>|<a href="Cesium3DTileset.html">Cesium3DTileset</a>|<a href="TimeDynamicPointCloud.html">TimeDynamicPointCloud</a>)></span>
</td>
<td class="description last">
The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
Object with the following properties:
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>duration</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">3.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The duration of the flight in seconds.</td>
</tr>
<tr>
<td class="name"><code>maximumHeight</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum height at the peak of the flight.</td>
</tr>
<tr>
<td class="name"><code>offset</code></td>
<td class="type">
<span class="param-type"><a href="HeadingPitchRange.html">HeadingPitchRange</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
The offset from the target in the local east-north-up reference frame centered at the target.</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A Promise that resolves to true if the flight was successful or false if the target is not currently visualized in the scene or the flight was cancelled. //TODO: Cleanup entity mentions
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="forceResize">
<a href="#forceResize" class="doc-link"></a>
forceResize<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1655">Widgets/Viewer/Viewer.js 1655</a>
</div>
</h4>
</div>
<div class="description">
This forces the widget to re-think its layout, including
widget sizes and credit placement.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="isDestroyed">
<a href="#isDestroyed" class="doc-link"></a>
isDestroyed<span class="signature">()</span> &rarr; <span class="type-signature returnType">Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1671">Widgets/Viewer/Viewer.js 1671</a>
</div>
</h4>
</div>
<h5>Returns:</h5>
<div class="param-desc">
true if the object has been destroyed, false otherwise.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="render">
<a href="#render" class="doc-link"></a>
render<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1664">Widgets/Viewer/Viewer.js 1664</a>
</div>
</h4>
</div>
<div class="description">
Renders the scene. This function is called automatically
unless <code>useDefaultRenderLoop</code> is set to false;
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="resize">
<a href="#resize" class="doc-link"></a>
resize<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L1553">Widgets/Viewer/Viewer.js 1553</a>
</div>
</h4>
</div>
<div class="description">
Resizes the widget to match the container size.
This function is called automatically as needed unless
<code>useDefaultRenderLoop</code> is set to false.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="zoomTo">
<a href="#zoomTo" class="doc-link"></a>
zoomTo<span class="signature">(target, <span class="optional">offset</span>)</span> &rarr; <span class="type-signature returnType">Promise.&lt;Boolean></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L2034">Widgets/Viewer/Viewer.js 2034</a>
</div>
</h4>
</div>
<div class="description">
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.
<p>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.</p>
<p>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.</p>
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type"><a href="Entity.html">Entity</a></span>
|
<span class="param-type">Array.&lt;<a href="Entity.html">Entity</a>></span>
|
<span class="param-type"><a href="EntityCollection.html">EntityCollection</a></span>
|
<span class="param-type"><a href="DataSource.html">DataSource</a></span>
|
<span class="param-type"><a href="ImageryLayer.html">ImageryLayer</a></span>
|
<span class="param-type"><a href="Cesium3DTileset.html">Cesium3DTileset</a></span>
|
<span class="param-type"><a href="TimeDynamicPointCloud.html">TimeDynamicPointCloud</a></span>
|
<span class="param-type">Promise.&lt;(<a href="Entity.html">Entity</a>|Array.&lt;<a href="Entity.html">Entity</a>>|<a href="EntityCollection.html">EntityCollection</a>|<a href="DataSource.html">DataSource</a>|<a href="ImageryLayer.html">ImageryLayer</a>|<a href="Cesium3DTileset.html">Cesium3DTileset</a>|<a href="TimeDynamicPointCloud.html">TimeDynamicPointCloud</a>)></span>
</td>
<td class="description last">
The entity, array of entities, entity collection, data source, Cesium3DTileset, point cloud, or imagery layer to view. You can also pass a promise that resolves to one of the previously mentioned types.</td>
</tr>
<tr>
<td class="name"><code>offset</code></td>
<td class="type">
<span class="param-type"><a href="HeadingPitchRange.html">HeadingPitchRange</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The offset from the center of the entity in the local east-north-up reference frame.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A Promise that resolves to true if the zoom was successful or false if the target is not currently visualized in the scene or the zoom was cancelled.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<div class="nameContainer">
<h4 class="name" id=".ConstructorOptions">
<a href="#.ConstructorOptions" class="doc-link"></a>
Cesium.Viewer.ConstructorOptions
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L291">Widgets/Viewer/Viewer.js 291</a>
</div>
</h4>
</div>
<div class="description">
Initialization options for the Viewer constructor
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>animation</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the Animation widget will not be created.</td>
</tr>
<tr>
<td class="name"><code>baseLayerPicker</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the BaseLayerPicker widget will not be created.</td>
</tr>
<tr>
<td class="name"><code>fullscreenButton</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the FullscreenButton widget will not be created.</td>
</tr>
<tr>
<td class="name"><code>vrButton</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">If set to true, the VRButton widget will be created.</td>
</tr>
<tr>
<td class="name"><code>geocoder</code></td>
<td class="type">
<span class="param-type">Boolean</span>
|
<span class="param-type">Array.&lt;<a href="GeocoderService.html">GeocoderService</a>></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the Geocoder widget will not be created.</td>
</tr>
<tr>
<td class="name"><code>homeButton</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the HomeButton widget will not be created.</td>
</tr>
<tr>
<td class="name"><code>infoBox</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the InfoBox widget will not be created.</td>
</tr>
<tr>
<td class="name"><code>sceneModePicker</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the SceneModePicker widget will not be created.</td>
</tr>
<tr>
<td class="name"><code>selectionIndicator</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the SelectionIndicator widget will not be created.</td>
</tr>
<tr>
<td class="name"><code>timeline</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the Timeline widget will not be created.</td>
</tr>
<tr>
<td class="name"><code>navigationHelpButton</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If set to false, the navigation help button will not be created.</td>
</tr>
<tr>
<td class="name"><code>navigationInstructionsInitiallyVisible</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button.</td>
</tr>
<tr>
<td class="name"><code>scene3DOnly</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">When <code>true</code>, each geometry instance will only be rendered in 3D to save GPU memory.</td>
</tr>
<tr>
<td class="name"><code>shouldAnimate</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><code>true</code> if the clock should attempt to advance simulation time by default, <code>false</code> otherwise. This option takes precedence over setting <a href="Viewer.html#clockViewModel"><code>Viewer#clockViewModel</code></a>.</td>
</tr>
<tr>
<td class="name"><code>clockViewModel</code></td>
<td class="type">
<span class="param-type"><a href="ClockViewModel.html">ClockViewModel</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
new ClockViewModel(clock)
</td>
<td class="description last">The clock view model to use to control current time.</td>
</tr>
<tr>
<td class="name"><code>selectedImageryProviderViewModel</code></td>
<td class="type">
<span class="param-type"><a href="ProviderViewModel.html">ProviderViewModel</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>imageryProviderViewModels</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ProviderViewModel.html">ProviderViewModel</a>></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
createDefaultImageryProviderViewModels()
</td>
<td class="description last">The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.</td>
</tr>
<tr>
<td class="name"><code>selectedTerrainProviderViewModel</code></td>
<td class="type">
<span class="param-type"><a href="ProviderViewModel.html">ProviderViewModel</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>terrainProviderViewModels</code></td>
<td class="type">
<span class="param-type">Array.&lt;<a href="ProviderViewModel.html">ProviderViewModel</a>></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
createDefaultTerrainProviderViewModels()
</td>
<td class="description last">The array of ProviderViewModels to be selectable from the BaseLayerPicker. This value is only valid if `baseLayerPicker` is set to true.</td>
</tr>
<tr>
<td class="name"><code>imageryProvider</code></td>
<td class="type">
<span class="param-type"><a href="ImageryProvider.html">ImageryProvider</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
createWorldImagery()
</td>
<td class="description last">The imagery provider to use. This value is only valid if `baseLayerPicker` is set to false.</td>
</tr>
<tr>
<td class="name"><code>terrainProvider</code></td>
<td class="type">
<span class="param-type"><a href="TerrainProvider.html">TerrainProvider</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
new EllipsoidTerrainProvider()
</td>
<td class="description last">The terrain provider to use</td>
</tr>
<tr>
<td class="name"><code>skyBox</code></td>
<td class="type">
<span class="param-type"><a href="SkyBox.html">SkyBox</a></span>
|
<span class="param-type">false</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The skybox used to render the stars. When <code>undefined</code>, the default stars are used. If set to <code>false</code>, no skyBox, Sun, or Moon will be added.</td>
</tr>
<tr>
<td class="name"><code>skyAtmosphere</code></td>
<td class="type">
<span class="param-type"><a href="SkyAtmosphere.html">SkyAtmosphere</a></span>
|
<span class="param-type">false</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">Blue sky, and the glow around the Earth's limb. Set to <code>false</code> to turn it off.</td>
</tr>
<tr>
<td class="name"><code>fullscreenElement</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
document.body
</td>
<td class="description last">The element or id to be placed into fullscreen mode when the full screen button is pressed.</td>
</tr>
<tr>
<td class="name"><code>useDefaultRenderLoop</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">True if this widget should control the render loop, false otherwise.</td>
</tr>
<tr>
<td class="name"><code>targetFrameRate</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The target frame rate when using the default render loop.</td>
</tr>
<tr>
<td class="name"><code>showRenderLoopErrors</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If true, this widget will automatically display an HTML panel to the user containing the error, if a render loop error occurs.</td>
</tr>
<tr>
<td class="name"><code>useBrowserRecommendedResolution</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If true, render at the browser's recommended resolution and ignore <code>window.devicePixelRatio</code>.</td>
</tr>
<tr>
<td class="name"><code>automaticallyTrackDataSourceClocks</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>contextOptions</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">Context and WebGL creation properties corresponding to <code>options</code> passed to <a href="Scene.html"><code>Scene</code></a>.</td>
</tr>
<tr>
<td class="name"><code>sceneMode</code></td>
<td class="type">
<span class="param-type"><a href="global.html#SceneMode">SceneMode</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
SceneMode.SCENE3D
</td>
<td class="description last">The initial scene mode.</td>
</tr>
<tr>
<td class="name"><code>mapProjection</code></td>
<td class="type">
<span class="param-type"><a href="MapProjection.html">MapProjection</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
new GeographicProjection()
</td>
<td class="description last">The map projection to use in 2D and Columbus View modes.</td>
</tr>
<tr>
<td class="name"><code>globe</code></td>
<td class="type">
<span class="param-type"><a href="Globe.html">Globe</a></span>
|
<span class="param-type">false</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
new Globe(mapProjection.ellipsoid)
</td>
<td class="description last">The globe to use in the scene. If set to <code>false</code>, no globe will be added.</td>
</tr>
<tr>
<td class="name"><code>orderIndependentTranslucency</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If true and the configuration supports it, use order independent translucency.</td>
</tr>
<tr>
<td class="name"><code>creditContainer</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The DOM element or ID that will contain the <a href="CreditDisplay.html"><code>CreditDisplay</code></a>. If not specified, the credits are added to the bottom of the widget itself.</td>
</tr>
<tr>
<td class="name"><code>creditViewport</code></td>
<td class="type">
<span class="param-type">Element</span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The DOM element or ID that will contain the credit pop up created by the <a href="CreditDisplay.html"><code>CreditDisplay</code></a>. If not specified, it will appear over the widget itself.</td>
</tr>
<tr>
<td class="name"><code>dataSources</code></td>
<td class="type">
<span class="param-type"><a href="DataSourceCollection.html">DataSourceCollection</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
new DataSourceCollection()
</td>
<td class="description last">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.</td>
</tr>
<tr>
<td class="name"><code>shadows</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">Determines if shadows are cast by light sources.</td>
</tr>
<tr>
<td class="name"><code>terrainShadows</code></td>
<td class="type">
<span class="param-type"><a href="global.html#ShadowMode">ShadowMode</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
ShadowMode.RECEIVE_ONLY
</td>
<td class="description last">Determines if the terrain casts or receives shadows from light sources.</td>
</tr>
<tr>
<td class="name"><code>mapMode2D</code></td>
<td class="type">
<span class="param-type"><a href="global.html#MapMode2D">MapMode2D</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
MapMode2D.INFINITE_SCROLL
</td>
<td class="description last">Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.</td>
</tr>
<tr>
<td class="name"><code>projectionPicker</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">If set to true, the ProjectionPicker widget will be created.</td>
</tr>
<tr>
<td class="name"><code>requestRenderMode</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last">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 <a href="Scene.html#requestRender"><code>Scene#requestRender</code></a> 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 <a href="https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/">Improving Performance with Explicit Rendering</a>.</td>
</tr>
<tr>
<td class="name"><code>maximumRenderTimeChange</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0.0
</td>
<td class="description last">If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested. See <a href="https://cesium.com/blog/2018/01/24/cesium-scene-rendering-performance/">Improving Performance with Explicit Rendering</a>.</td>
</tr>
<tr>
<td class="name"><code>depthPlaneEllipsoidOffset</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0.0
</td>
<td class="description last">Adjust the DepthPlane to address rendering artefacts below ellipsoid zero elevation.</td>
</tr>
<tr>
<td class="name"><code>msaaSamples</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
1
</td>
<td class="description last">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.</td>
</tr>
</tbody>
</table>
</dl>
<div class="nameContainer">
<h4 class="name" id=".ViewerMixin">
<a href="#.ViewerMixin" class="doc-link"></a>
Cesium.Viewer.ViewerMixin<span class="signature">(viewer, options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/Viewer/Viewer.js#L2402">Widgets/Viewer/Viewer.js 2402</a>
</div>
</h4>
</div>
<div class="description">
A function that augments a Viewer instance with additional functionality.
</div>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>viewer</code></td>
<td class="type">
<span class="param-type"><a href="Viewer.html">Viewer</a></span>
</td>
<td class="description last">
The viewer instance.</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
Options object to be passed to the mixin function.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="Viewer.html#extend">Viewer#extend</a></li>
</ul>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>