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

3106 lines
91 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>GoogleEarthEnterpriseMapsProvider - 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>
GoogleEarthEnterpriseMapsProvider
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="GoogleEarthEnterpriseMapsProvider">
<a href="#GoogleEarthEnterpriseMapsProvider" class="doc-link"></a>
new Cesium.GoogleEarthEnterpriseMapsProvider<span class="signature">(options)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L92">Scene/GoogleEarthEnterpriseMapsProvider.js 92</a>
</div>
</h4>
</div>
<div class="description">
Provides tiled imagery using the Google Earth Imagery API.
Notes: This imagery provider does not work with the public Google Earth servers. It works with the
Google Earth Enterprise Server.
By default the Google Earth Enterprise server does not set the
<a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a> headers. You can either
use a proxy server which adds these headers, or in the /opt/google/gehttpd/conf/gehttpd.conf
and add the 'Header set Access-Control-Allow-Origin "*"' option to the '&lt;Directory /&gt;' and
'&lt;Directory "/opt/google/gehttpd/htdocs"&gt;' directives.
This provider is for use with 2D Maps API as part of Google Earth Enterprise. For 3D Earth API uses, it
is necessary to use <a href="GoogleEarthEnterpriseImageryProvider.html"><code>GoogleEarthEnterpriseImageryProvider</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"><a href="GoogleEarthEnterpriseMapsProvider.html#.ConstructorOptions">GoogleEarthEnterpriseMapsProvider.ConstructorOptions</a></span>
</td>
<td class="description last">
Object describing initialization options</td>
</tr>
</tbody>
</table>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
: Could not find layer with channel (id) of <code>options.channel</code>.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
: Could not find a version in channel (id) <code>options.channel</code>.
</div>
</li>
<li>
<div class="param-desc">
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
: Unsupported projection <code>data.projection</code>.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">const google = new Cesium.GoogleEarthEnterpriseMapsProvider({
url : 'https://earth.localdomain',
channel : 1008
});</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li>
<li><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li>
<li><a href="OpenStreetMapImageryProvider.html">OpenStreetMapImageryProvider</a></li>
<li><a href="SingleTileImageryProvider.html">SingleTileImageryProvider</a></li>
<li><a href="TileMapServiceImageryProvider.html">TileMapServiceImageryProvider</a></li>
<li><a href="WebMapServiceImageryProvider.html">WebMapServiceImageryProvider</a></li>
<li><a href="WebMapTileServiceImageryProvider.html">WebMapTileServiceImageryProvider</a></li>
<li><a href="UrlTemplateImageryProvider.html">UrlTemplateImageryProvider</a></li>
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id=".logoUrl">
<a href="#.logoUrl" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.GoogleEarthEnterpriseMapsProvider.logoUrl<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L748">Scene/GoogleEarthEnterpriseMapsProvider.js 748</a>
</div>
</h4>
</div>
<div class="description">
Gets or sets the URL to the Google Earth logo for display in the credit.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="channel">
<a href="#channel" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> channel<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L389">Scene/GoogleEarthEnterpriseMapsProvider.js 389</a>
</div>
</h4>
</div>
<div class="description">
Gets the imagery channel (id) currently being used.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="credit">
<a href="#credit" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> credit<span class="type-signature"> : <a href="Credit.html">Credit</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L630">Scene/GoogleEarthEnterpriseMapsProvider.js 630</a>
</div>
</h4>
</div>
<div class="description">
Gets the credit to display when this imagery provider is active. Typically this is used to credit
the source of the imagery. This function should not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultAlpha">
<a href="#defaultAlpha" class="doc-link"></a>
defaultAlpha<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L111">Scene/GoogleEarthEnterpriseMapsProvider.js 111</a>
</div>
</h4>
</div>
<div class="description">
The default alpha blending value of this provider, with 0.0 representing fully transparent and
1.0 representing fully opaque.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultBrightness">
<a href="#defaultBrightness" class="doc-link"></a>
defaultBrightness<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L138">Scene/GoogleEarthEnterpriseMapsProvider.js 138</a>
</div>
</h4>
</div>
<div class="description">
The default brightness of this provider. 1.0 uses the unmodified imagery color. Less than 1.0
makes the imagery darker while greater than 1.0 makes it brighter.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultContrast">
<a href="#defaultContrast" class="doc-link"></a>
defaultContrast<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L147">Scene/GoogleEarthEnterpriseMapsProvider.js 147</a>
</div>
</h4>
</div>
<div class="description">
The default contrast of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces
the contrast while greater than 1.0 increases it.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultDayAlpha">
<a href="#defaultDayAlpha" class="doc-link"></a>
defaultDayAlpha<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L129">Scene/GoogleEarthEnterpriseMapsProvider.js 129</a>
</div>
</h4>
</div>
<div class="description">
The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and
1.0 representing fully opaque.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultGamma">
<a href="#defaultGamma" class="doc-link"></a>
defaultGamma<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L172">Scene/GoogleEarthEnterpriseMapsProvider.js 172</a>
</div>
</h4>
</div>
<div class="description">
The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1.9</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultHue">
<a href="#defaultHue" class="doc-link"></a>
defaultHue<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L155">Scene/GoogleEarthEnterpriseMapsProvider.js 155</a>
</div>
</h4>
</div>
<div class="description">
The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultMagnificationFilter">
<a href="#defaultMagnificationFilter" class="doc-link"></a>
defaultMagnificationFilter<span class="type-signature"> : <a href="global.html#TextureMagnificationFilter">TextureMagnificationFilter</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L188">Scene/GoogleEarthEnterpriseMapsProvider.js 188</a>
</div>
</h4>
</div>
<div class="description">
The default texture magnification filter to apply to this provider.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultMinificationFilter">
<a href="#defaultMinificationFilter" class="doc-link"></a>
defaultMinificationFilter<span class="type-signature"> : <a href="global.html#TextureMinificationFilter">TextureMinificationFilter</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L180">Scene/GoogleEarthEnterpriseMapsProvider.js 180</a>
</div>
</h4>
</div>
<div class="description">
The default texture minification filter to apply to this provider.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultNightAlpha">
<a href="#defaultNightAlpha" class="doc-link"></a>
defaultNightAlpha<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L120">Scene/GoogleEarthEnterpriseMapsProvider.js 120</a>
</div>
</h4>
</div>
<div class="description">
The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and
1.0 representing fully opaque.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="defaultSaturation">
<a href="#defaultSaturation" class="doc-link"></a>
defaultSaturation<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L164">Scene/GoogleEarthEnterpriseMapsProvider.js 164</a>
</div>
</h4>
</div>
<div class="description">
The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
saturation while greater than 1.0 increases it.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="errorEvent">
<a href="#errorEvent" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> errorEvent<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/Scene/GoogleEarthEnterpriseMapsProvider.js#L593">Scene/GoogleEarthEnterpriseMapsProvider.js 593</a>
</div>
</h4>
</div>
<div class="description">
Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing
to the event, you will be notified of the error and can potentially recover from it. Event listeners
are passed an instance of <a href="TileProviderError.html"><code>TileProviderError</code></a>.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="hasAlphaChannel">
<a href="#hasAlphaChannel" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> hasAlphaChannel<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L646">Scene/GoogleEarthEnterpriseMapsProvider.js 646</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating whether or not the images provided by this imagery provider
include an alpha channel. If this property is false, an alpha channel, if present, will
be ignored. If this property is true, any images without an alpha channel will be treated
as if their alpha is 1.0 everywhere. When this property is false, memory usage
and texture upload time are reduced.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="maximumLevel">
<a href="#maximumLevel" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> maximumLevel<span class="type-signature"> : Number|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L444">Scene/GoogleEarthEnterpriseMapsProvider.js 444</a>
</div>
</h4>
</div>
<div class="description">
Gets the maximum level-of-detail that can be requested. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="minimumLevel">
<a href="#minimumLevel" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> minimumLevel<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L465">Scene/GoogleEarthEnterpriseMapsProvider.js 465</a>
</div>
</h4>
</div>
<div class="description">
Gets the minimum level-of-detail that can be requested. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="path">
<a href="#path" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> path<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L365">Scene/GoogleEarthEnterpriseMapsProvider.js 365</a>
</div>
</h4>
</div>
<div class="description">
Gets the url path of the data on the Google Earth server.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="proxy">
<a href="#proxy" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> proxy<span class="type-signature"> : <a href="Proxy.html">Proxy</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L377">Scene/GoogleEarthEnterpriseMapsProvider.js 377</a>
</div>
</h4>
</div>
<div class="description">
Gets the proxy used by this provider.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="ready">
<a href="#ready" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> ready<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L605">Scene/GoogleEarthEnterpriseMapsProvider.js 605</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating whether or not the provider is ready for use.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="readyPromise">
<a href="#readyPromise" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> readyPromise<span class="type-signature"> : Promise.&lt;Boolean></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L617">Scene/GoogleEarthEnterpriseMapsProvider.js 617</a>
</div>
</h4>
</div>
<div class="description">
Gets a promise that resolves to true when the provider is ready for use.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="rectangle">
<a href="#rectangle" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> rectangle<span class="type-signature"> : <a href="Rectangle.html">Rectangle</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L548">Scene/GoogleEarthEnterpriseMapsProvider.js 548</a>
</div>
</h4>
</div>
<div class="description">
Gets the rectangle, in radians, of the imagery provided by this instance. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="requestType">
<a href="#requestType" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> requestType<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L528">Scene/GoogleEarthEnterpriseMapsProvider.js 528</a>
</div>
</h4>
</div>
<div class="description">
Gets the type of data that is being requested from the provider. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tileDiscardPolicy">
<a href="#tileDiscardPolicy" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tileDiscardPolicy<span class="type-signature"> : <a href="TileDiscardPolicy.html">TileDiscardPolicy</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L571">Scene/GoogleEarthEnterpriseMapsProvider.js 571</a>
</div>
</h4>
</div>
<div class="description">
Gets the tile discard policy. If not undefined, the discard policy is responsible
for filtering out "missing" tiles via its shouldDiscardImage function. If this function
returns undefined, no tiles are filtered. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tileHeight">
<a href="#tileHeight" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tileHeight<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L423">Scene/GoogleEarthEnterpriseMapsProvider.js 423</a>
</div>
</h4>
</div>
<div class="description">
Gets the height of each tile, in pixels. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tileWidth">
<a href="#tileWidth" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tileWidth<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L402">Scene/GoogleEarthEnterpriseMapsProvider.js 402</a>
</div>
</h4>
</div>
<div class="description">
Gets the width of each tile, in pixels. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="tilingScheme">
<a href="#tilingScheme" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> tilingScheme<span class="type-signature"> : <a href="TilingScheme.html">TilingScheme</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L486">Scene/GoogleEarthEnterpriseMapsProvider.js 486</a>
</div>
</h4>
</div>
<div class="description">
Gets the tiling scheme used by this provider. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="url">
<a href="#url" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> url<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L353">Scene/GoogleEarthEnterpriseMapsProvider.js 353</a>
</div>
</h4>
</div>
<div class="description">
Gets the URL of the Google Earth MapServer.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="version">
<a href="#version" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> version<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L507">Scene/GoogleEarthEnterpriseMapsProvider.js 507</a>
</div>
</h4>
</div>
<div class="description">
Gets the version of the data used by this provider. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</div>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<div class="nameContainer">
<h4 class="name" id="getTileCredits">
<a href="#getTileCredits" class="doc-link"></a>
getTileCredits<span class="signature">(x, y, level)</span> &rarr; <span class="type-signature returnType">Array.&lt;<a href="Credit.html">Credit</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L663">Scene/GoogleEarthEnterpriseMapsProvider.js 663</a>
</div>
</h4>
</div>
<div class="description">
Gets the credits to be displayed when a given tile is displayed.
</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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile X coordinate.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile Y coordinate.</td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile level;</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The credits to be displayed when the tile is displayed.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: <code>getTileCredits</code> must not be called before the imagery provider is ready.
</div>
</li>
</ul>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="pickFeatures">
<a href="#pickFeatures" class="doc-link"></a>
pickFeatures<span class="signature">(x, y, level, longitude, latitude)</span> &rarr; <span class="type-signature returnType">Promise.&lt;Array.&lt;<a href="ImageryLayerFeatureInfo.html">ImageryLayerFeatureInfo</a>>>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L730">Scene/GoogleEarthEnterpriseMapsProvider.js 730</a>
</div>
</h4>
</div>
<div class="description">
Picking features is not currently supported by this imagery provider, so this function simply returns
undefined.
</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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile X coordinate.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile Y coordinate.</td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile level.</td>
</tr>
<tr>
<td class="name"><code>longitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The longitude at which to pick features.</td>
</tr>
<tr>
<td class="name"><code>latitude</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The latitude at which to pick features.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A promise for the picked features that will resolve when the asynchronous
picking completes. The resolved value is an array of <a href="ImageryLayerFeatureInfo.html"><code>ImageryLayerFeatureInfo</code></a>
instances. The array may be empty if no features are found at the given location.
It may also be undefined if picking is not supported.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="requestImage">
<a href="#requestImage" class="doc-link"></a>
requestImage<span class="signature">(x, y, level, <span class="optional">request</span>)</span> &rarr; <span class="type-signature returnType">Promise.&lt;(HTMLImageElement|HTMLCanvasElement)>|undefined</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L686">Scene/GoogleEarthEnterpriseMapsProvider.js 686</a>
</div>
</h4>
</div>
<div class="description">
Requests the image for a given tile. This function should
not be called before <a href="GoogleEarthEnterpriseMapsProvider.html#ready"><code>GoogleEarthEnterpriseMapsProvider#ready</code></a> returns true.
</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>x</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile X coordinate.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile Y coordinate.</td>
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">
The tile level.</td>
</tr>
<tr>
<td class="name"><code>request</code></td>
<td class="type">
<span class="param-type"><a href="Request.html">Request</a></span>
</td>
<td class="description last">
<span class="optional">optional</span>
The request object. Intended for internal use only.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
A promise for the image that will resolve when the image is available, or
undefined if there are too many active requests to the server, and the request
should be retried later. The resolved image may be either an
Image or a Canvas DOM object.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: <code>requestImage</code> must not be called before the imagery provider is ready.
</div>
</li>
</ul>
<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.GoogleEarthEnterpriseMapsProvider.ConstructorOptions
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/GoogleEarthEnterpriseMapsProvider.js#L17">Scene/GoogleEarthEnterpriseMapsProvider.js 17</a>
</div>
</h4>
</div>
<div class="description">
Initialization options for the GoogleEarthEnterpriseMapsProvider 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>url</code></td>
<td class="type">
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">The url of the Google Earth server hosting the imagery.</td>
</tr>
<tr>
<td class="name"><code>channel</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last">The channel (id) to be used when requesting data from the server.
The channel number can be found by looking at the json file located at:
earth.localdomain/default_map/query?request=Json&vars=geeServerDefs The /default_map path may
differ depending on your Google Earth Enterprise server configuration. Look for the "id" that
is associated with a "ImageryMaps" requestType. There may be more than one id available.
Example:
{
layers: [
{
id: 1002,
requestType: "ImageryMaps"
},
{
id: 1007,
requestType: "VectorMapsRaster"
}
]
}</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
"/default_map"
</td>
<td class="description last">The path of the Google Earth server hosting the imagery.</td>
</tr>
<tr>
<td class="name"><code>maximumLevel</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 maximum level-of-detail supported by the Google Earth
Enterprise server, or undefined if there is no limit.</td>
</tr>
<tr>
<td class="name"><code>tileDiscardPolicy</code></td>
<td class="type">
<span class="param-type"><a href="TileDiscardPolicy.html">TileDiscardPolicy</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The policy that determines if a tile
is invalid and should be discarded. To ensure that no tiles are discarded, construct and pass
a <a href="NeverTileDiscardPolicy.html"><code>NeverTileDiscardPolicy</code></a> for this parameter.</td>
</tr>
<tr>
<td class="name"><code>ellipsoid</code></td>
<td class="type">
<span class="param-type"><a href="Ellipsoid.html">Ellipsoid</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
</td>
<td class="description last">The ellipsoid. If not specified, the WGS84 ellipsoid is used.</td>
</tr>
</tbody>
</table>
</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>