637 lines
55 KiB
HTML
637 lines
55 KiB
HTML
|
<!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>PerformanceWatchdogViewModel - 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>
|
||
|
|
PerformanceWatchdogViewModel
|
||
|
|
<div class="titleCenterer"></div>
|
||
|
|
</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
|
||
|
|
<header>
|
||
|
|
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<article>
|
||
|
|
<div class="container-overview">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="PerformanceWatchdogViewModel">
|
||
|
|
<a href="#PerformanceWatchdogViewModel" class="doc-link"></a>
|
||
|
|
new Cesium.PerformanceWatchdogViewModel<span class="signature">(<span class="optional">options</span>)</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js#L21">Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js 21</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
The view model for <a href="PerformanceWatchdog.html"><code>PerformanceWatchdog</code></a>.
|
||
|
|
</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>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>scene</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><a href="Scene.html">Scene</a></span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="default">
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
The Scene instance for which to monitor performance.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>lowFrameRateMessage</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type">String</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="default">
|
||
|
|
|
||
|
|
<code class="language-javascript">'This application appears to be performing poorly on your system. Please try using a different web browser or updating your video drivers.'</code>
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="optional">optional</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
The
|
||
|
|
message to display when a low frame rate is detected. The message is interpeted as HTML, so make sure
|
||
|
|
it comes from a trusted source so that your application is not vulnerable to cross-site scripting attacks.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h3 class="subsection-title">Members</h3>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="dismissMessage">
|
||
|
|
<a href="#dismissMessage" class="doc-link"></a>
|
||
|
|
dismissMessage<span class="type-signature"> : <a href="Command.html">Command</a></span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js#L99">Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js 99</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Gets a command that dismisses the low frame rate message. Once it is dismissed, the message
|
||
|
|
will not be redisplayed.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="lowFrameRateMessage">
|
||
|
|
<a href="#lowFrameRateMessage" class="doc-link"></a>
|
||
|
|
lowFrameRateMessage<span class="type-signature"> : String</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js#L34">Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js 34</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Gets or sets the message to display when a low frame rate is detected. This string will be interpreted as HTML.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="lowFrameRateMessageDismissed">
|
||
|
|
<a href="#lowFrameRateMessageDismissed" class="doc-link"></a>
|
||
|
|
lowFrameRateMessageDismissed<span class="type-signature"> : Boolean</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js#L44">Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js 44</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Gets or sets a value indicating whether the low frame rate message has previously been dismissed by the user. If it has
|
||
|
|
been dismissed, the message will not be redisplayed, no matter the frame rate.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="scene">
|
||
|
|
<a href="#scene" class="doc-link"></a>
|
||
|
|
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/PerformanceWatchdog/PerformanceWatchdogViewModel.js#L87">Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js 87</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Gets the <a href="Scene.html"><code>Scene</code></a> instance for which to monitor performance.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="showingLowFrameRateMessage">
|
||
|
|
<a href="#showingLowFrameRateMessage" class="doc-link"></a>
|
||
|
|
showingLowFrameRateMessage<span class="type-signature"> : Boolean</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js#L50">Widgets/PerformanceWatchdog/PerformanceWatchdogViewModel.js 50</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Gets or sets a value indicating whether the low frame rate message is currently being displayed.
|
||
|
|
</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>
|