qd-changjing/public/static/Build/Documentation/Fullscreen.html

814 lines
57 KiB
HTML
Raw Normal View History

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>Fullscreen - 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>
Fullscreen
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Fullscreen.js#L13">Core/Fullscreen.js 13</a>
</div>
<div class="description">Browser-independent functions for working with the standard fullscreen API.</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="http://dvcs.w3.org/hg/fullscreen/raw-file/tip/Overview.html">W3C Fullscreen Living Specification</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".changeEventName">
<a href="#.changeEventName" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-readonly">readonly</span> Cesium.Fullscreen.changeEventName<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Fullscreen.js#L49">Core/Fullscreen.js 49</a>
</div>
</h4>
</div>
<div class="description">
The name of the event on the document that is fired when fullscreen is
entered or exited. This event name is intended for use with addEventListener.
In your event handler, to determine if the browser is in fullscreen mode or not,
use <code>Fullscreen#fullscreen</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".element">
<a href="#.element" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-readonly">readonly</span> Cesium.Fullscreen.element<span class="type-signature"> : Object</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Fullscreen.js#L30">Core/Fullscreen.js 30</a>
</div>
</h4>
</div>
<div class="description">
The element that is currently fullscreen, if any. To simply check if the
browser is in fullscreen mode or not, use <code>Fullscreen#fullscreen</code>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".enabled">
<a href="#.enabled" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-readonly">readonly</span> Cesium.Fullscreen.enabled<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Fullscreen.js#L84">Core/Fullscreen.js 84</a>
</div>
</h4>
</div>
<div class="description">
Determine whether the browser will allow an element to be made fullscreen, or not.
For example, by default, iframes cannot go fullscreen unless the containing page
adds an "allowfullscreen" attribute (or prefixed equivalent).
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".errorEventName">
<a href="#.errorEventName" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-readonly">readonly</span> Cesium.Fullscreen.errorEventName<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Fullscreen.js#L66">Core/Fullscreen.js 66</a>
</div>
</h4>
</div>
<div class="description">
The name of the event that is fired when a fullscreen error
occurs. This event name is intended for use with addEventListener.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".fullscreen">
<a href="#.fullscreen" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> <span class="type-signature attribute-readonly">readonly</span> Cesium.Fullscreen.fullscreen<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Fullscreen.js#L100">Core/Fullscreen.js 100</a>
</div>
</h4>
</div>
<div class="description">
Determines if the browser is currently in fullscreen mode.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id=".exitFullscreen">
<a href="#.exitFullscreen" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Fullscreen.exitFullscreen<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Fullscreen.js#L239">Core/Fullscreen.js 239</a>
</div>
</h4>
</div>
<div class="description">
Asynchronously exits fullscreen mode. If the browser is not currently
in fullscreen, or if fullscreen mode is not supported by the browser, does nothing.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id=".requestFullscreen">
<a href="#.requestFullscreen" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Fullscreen.requestFullscreen<span class="signature">(element, <span class="optional">vrDevice</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Core/Fullscreen.js#L227">Core/Fullscreen.js 227</a>
</div>
</h4>
</div>
<div class="description">
Asynchronously requests the browser to enter fullscreen mode on the given element.
If fullscreen mode is not supported by the browser, does nothing.
</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>element</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
The HTML element which will be placed into fullscreen mode.</td>
</tr>
<tr>
<td class="name"><code>vrDevice</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">
<span class="optional">optional</span>
The HMDVRDevice device.</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Put the entire page into fullscreen.
Cesium.Fullscreen.requestFullscreen(document.body)
// Place only the Cesium canvas into fullscreen.
Cesium.Fullscreen.requestFullscreen(scene.canvas)</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id=".supportsFullscreen">
<a href="#.supportsFullscreen" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.Fullscreen.supportsFullscreen<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/Core/Fullscreen.js#L117">Core/Fullscreen.js 117</a>
</div>
</h4>
</div>
<div class="description">
Detects whether the browser supports the standard fullscreen API.
</div>
<h5>Returns:</h5>
<div class="param-desc">
<code>true</code> if the browser supports the standard fullscreen API,
<code>false</code> otherwise.
</div>
<dl class="details">
</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>