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

3113 lines
98 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>ImageryLayer - 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>
ImageryLayer
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="ImageryLayer">
<a href="#ImageryLayer" class="doc-link"></a>
new Cesium.ImageryLayer<span class="signature">(imageryProvider, <span class="optional">options</span>)</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L129">Scene/ImageryLayer.js 129</a>
</div>
</h4>
</div>
<div class="description">
An imagery layer that displays tiled image data from a single imagery provider
on a <a href="Globe.html"><code>Globe</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>imageryProvider</code></td>
<td class="type">
<span class="param-type"><a href="ImageryProvider.html">ImageryProvider</a></span>
</td>
<td class="description last">
The imagery provider to use.</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>rectangle</code></td>
<td class="type">
<span class="param-type"><a href="Rectangle.html">Rectangle</a></span>
</td>
<td class="default">
<code class="language-javascript">imageryProvider.rectangle</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The rectangle of the layer. This rectangle
can limit the visible portion of the imagery provider.</td>
</tr>
<tr>
<td class="name"><code>alpha</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">function</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The alpha blending value of this layer, from 0.0 to 1.0.
This can either be a simple number or a function with the signature
<code>function(frameState, layer, x, y, level)</code>. The function is passed the
current frame state, this layer, and the x, y, and level coordinates of the
imagery tile for which the alpha is required, and it is expected to return
the alpha value to use for the tile.</td>
</tr>
<tr>
<td class="name"><code>nightAlpha</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">function</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The alpha blending value of this layer on the night side of the globe, from 0.0 to 1.0.
This can either be a simple number or a function with the signature
<code>function(frameState, layer, x, y, level)</code>. The function is passed the
current frame state, this layer, and the x, y, and level coordinates of the
imagery tile for which the alpha is required, and it is expected to return
the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.</td>
</tr>
<tr>
<td class="name"><code>dayAlpha</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">function</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The alpha blending value of this layer on the day side of the globe, from 0.0 to 1.0.
This can either be a simple number or a function with the signature
<code>function(frameState, layer, x, y, level)</code>. The function is passed the
current frame state, this layer, and the x, y, and level coordinates of the
imagery tile for which the alpha is required, and it is expected to return
the alpha value to use for the tile. This only takes effect when <code>enableLighting</code> is <code>true</code>.</td>
</tr>
<tr>
<td class="name"><code>brightness</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">function</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The brightness of this layer. 1.0 uses the unmodified imagery
color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter.
This can either be a simple number or a function with the signature
<code>function(frameState, layer, x, y, level)</code>. The function is passed the
current frame state, this layer, and the x, y, and level coordinates of the
imagery tile for which the brightness is required, and it is expected to return
the brightness value to use for the tile. The function is executed for every
frame and for every tile, so it must be fast.</td>
</tr>
<tr>
<td class="name"><code>contrast</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">function</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The contrast of this layer. 1.0 uses the unmodified imagery color.
Less than 1.0 reduces the contrast while greater than 1.0 increases it.
This can either be a simple number or a function with the signature
<code>function(frameState, layer, x, y, level)</code>. The function is passed the
current frame state, this layer, and the x, y, and level coordinates of the
imagery tile for which the contrast is required, and it is expected to return
the contrast value to use for the tile. The function is executed for every
frame and for every tile, so it must be fast.</td>
</tr>
<tr>
<td class="name"><code>hue</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">function</span>
</td>
<td class="default">
<code class="language-javascript">0.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The hue of this layer. 0.0 uses the unmodified imagery color.
This can either be a simple number or a function with the signature
<code>function(frameState, layer, x, y, level)</code>. The function is passed the
current frame state, this layer, and the x, y, and level coordinates
of the imagery tile for which the hue is required, and it is expected to return
the contrast value to use for the tile. The function is executed for every
frame and for every tile, so it must be fast.</td>
</tr>
<tr>
<td class="name"><code>saturation</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">function</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The saturation of this layer. 1.0 uses the unmodified imagery color.
Less than 1.0 reduces the saturation while greater than 1.0 increases it.
This can either be a simple number or a function with the signature
<code>function(frameState, layer, x, y, level)</code>. The function is passed the
current frame state, this layer, and the x, y, and level coordinates
of the imagery tile for which the saturation is required, and it is expected to return
the contrast value to use for the tile. The function is executed for every
frame and for every tile, so it must be fast.</td>
</tr>
<tr>
<td class="name"><code>gamma</code></td>
<td class="type">
<span class="param-type">Number</span>
|
<span class="param-type">function</span>
</td>
<td class="default">
<code class="language-javascript">1.0</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.
This can either be a simple number or a function with the signature
<code>function(frameState, layer, x, y, level)</code>. The function is passed the
current frame state, this layer, and the x, y, and level coordinates of the
imagery tile for which the gamma is required, and it is expected to return
the gamma value to use for the tile. The function is executed for every
frame and for every tile, so it must be fast.</td>
</tr>
<tr>
<td class="name"><code>splitDirection</code></td>
<td class="type">
<span class="param-type"><a href="global.html#ImagerySplitDirection">ImagerySplitDirection</a></span>
|
<span class="param-type">function</span>
</td>
<td class="default">
<code class="language-javascript">ImagerySplitDirection.NONE</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The <a href="global.html#ImagerySplitDirection"><code>ImagerySplitDirection</code></a> split to apply to this layer.</td>
</tr>
<tr>
<td class="name"><code>minificationFilter</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TextureMinificationFilter">TextureMinificationFilter</a></span>
</td>
<td class="default">
<code class="language-javascript">TextureMinificationFilter.LINEAR</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The
texture minification filter to apply to this layer. Possible values
are <code>TextureMinificationFilter.LINEAR</code> and
<code>TextureMinificationFilter.NEAREST</code>.</td>
</tr>
<tr>
<td class="name"><code>magnificationFilter</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TextureMagnificationFilter">TextureMagnificationFilter</a></span>
</td>
<td class="default">
<code class="language-javascript">TextureMagnificationFilter.LINEAR</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The
texture minification filter to apply to this layer. Possible values
are <code>TextureMagnificationFilter.LINEAR</code> and
<code>TextureMagnificationFilter.NEAREST</code>.</td>
</tr>
<tr>
<td class="name"><code>show</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="default">
<code class="language-javascript">true</code>
</td>
<td class="description last">
<span class="optional">optional</span>
True if the layer is shown; otherwise, false.</td>
</tr>
<tr>
<td class="name"><code>maximumAnisotropy</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">maximum supported</code>
</td>
<td class="description last">
<span class="optional">optional</span>
The maximum anisotropy level to use
for texture filtering. If this parameter is not specified, the maximum anisotropy supported
by the WebGL stack will be used. Larger values make the imagery look better in horizon
views.</td>
</tr>
<tr>
<td class="name"><code>minimumTerrainLevel</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 minimum terrain level-of-detail at which to show this imagery layer,
or undefined to show it at all levels. Level zero is the least-detailed level.</td>
</tr>
<tr>
<td class="name"><code>maximumTerrainLevel</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 terrain level-of-detail at which to show this imagery layer,
or undefined to show it at all levels. Level zero is the least-detailed level.</td>
</tr>
<tr>
<td class="name"><code>cutoutRectangle</code></td>
<td class="type">
<span class="param-type"><a href="Rectangle.html">Rectangle</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Cartographic rectangle for cutting out a portion of this ImageryLayer.</td>
</tr>
<tr>
<td class="name"><code>colorToAlpha</code></td>
<td class="type">
<span class="param-type"><a href="Color.html">Color</a></span>
</td>
<td class="default">
</td>
<td class="description last">
<span class="optional">optional</span>
Color to be used as alpha.</td>
</tr>
<tr>
<td class="name"><code>colorToAlphaThreshold</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
<code class="language-javascript">0.004</code>
</td>
<td class="description last">
<span class="optional">optional</span>
Threshold for color-to-alpha.</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=".DEFAULT_APPLY_COLOR_TO_ALPHA_THRESHOLD">
<a href="#.DEFAULT_APPLY_COLOR_TO_ALPHA_THRESHOLD" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ImageryLayer.DEFAULT_APPLY_COLOR_TO_ALPHA_THRESHOLD<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L432">Scene/ImageryLayer.js 432</a>
</div>
</h4>
</div>
<div class="description">
This value is used as the default threshold for color-to-alpha if one is not provided
during construction or by the imagery provider.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.004</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".DEFAULT_BRIGHTNESS">
<a href="#.DEFAULT_BRIGHTNESS" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ImageryLayer.DEFAULT_BRIGHTNESS<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L372">Scene/ImageryLayer.js 372</a>
</div>
</h4>
</div>
<div class="description">
This value is used as the default brightness for the imagery layer if one is not provided during construction
or by the imagery provider. This value does not modify the brightness of the imagery.
</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=".DEFAULT_CONTRAST">
<a href="#.DEFAULT_CONTRAST" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ImageryLayer.DEFAULT_CONTRAST<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L379">Scene/ImageryLayer.js 379</a>
</div>
</h4>
</div>
<div class="description">
This value is used as the default contrast for the imagery layer if one is not provided during construction
or by the imagery provider. This value does not modify the contrast of the imagery.
</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=".DEFAULT_GAMMA">
<a href="#.DEFAULT_GAMMA" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ImageryLayer.DEFAULT_GAMMA<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L400">Scene/ImageryLayer.js 400</a>
</div>
</h4>
</div>
<div class="description">
This value is used as the default gamma for the imagery layer if one is not provided during construction
or by the imagery provider. This value does not modify the gamma of the imagery.
</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=".DEFAULT_HUE">
<a href="#.DEFAULT_HUE" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ImageryLayer.DEFAULT_HUE<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L386">Scene/ImageryLayer.js 386</a>
</div>
</h4>
</div>
<div class="description">
This value is used as the default hue for the imagery layer if one is not provided during construction
or by the imagery provider. This value does not modify the hue of the imagery.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">0.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".DEFAULT_MAGNIFICATION_FILTER">
<a href="#.DEFAULT_MAGNIFICATION_FILTER" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ImageryLayer.DEFAULT_MAGNIFICATION_FILTER<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/ImageryLayer.js#L424">Scene/ImageryLayer.js 424</a>
</div>
</h4>
</div>
<div class="description">
This value is used as the default texture magnification filter for the imagery layer if one is not provided
during construction or by the imagery provider.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">TextureMagnificationFilter.LINEAR</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".DEFAULT_MINIFICATION_FILTER">
<a href="#.DEFAULT_MINIFICATION_FILTER" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ImageryLayer.DEFAULT_MINIFICATION_FILTER<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/ImageryLayer.js#L416">Scene/ImageryLayer.js 416</a>
</div>
</h4>
</div>
<div class="description">
This value is used as the default texture minification filter for the imagery layer if one is not provided
during construction or by the imagery provider.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">TextureMinificationFilter.LINEAR</code>
</dl>
<div class="nameContainer">
<h4 class="name" id=".DEFAULT_SATURATION">
<a href="#.DEFAULT_SATURATION" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ImageryLayer.DEFAULT_SATURATION<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L393">Scene/ImageryLayer.js 393</a>
</div>
</h4>
</div>
<div class="description">
This value is used as the default saturation for the imagery layer if one is not provided during construction
or by the imagery provider. This value does not modify the saturation of the imagery.
</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=".DEFAULT_SPLIT">
<a href="#.DEFAULT_SPLIT" class="doc-link"></a>
<span class="type-signature attribute-static">static</span> Cesium.ImageryLayer.DEFAULT_SPLIT<span class="type-signature"> : <a href="global.html#ImagerySplitDirection">ImagerySplitDirection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L408">Scene/ImageryLayer.js 408</a>
</div>
</h4>
</div>
<div class="description">
This value is used as the default split for the imagery layer if one is not provided during construction
or by the imagery provider.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">ImagerySplitDirection.NONE</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="alpha">
<a href="#alpha" class="doc-link"></a>
alpha<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L141">Scene/ImageryLayer.js 141</a>
</div>
</h4>
</div>
<div class="description">
The alpha blending value of this layer, 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">1.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="brightness">
<a href="#brightness" class="doc-link"></a>
brightness<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L177">Scene/ImageryLayer.js 177</a>
</div>
</h4>
</div>
<div class="description">
The brightness of this layer. 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"><a href="ImageryLayer.html#.DEFAULT_BRIGHTNESS"><code>ImageryLayer.DEFAULT_BRIGHTNESS</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="colorToAlpha">
<a href="#colorToAlpha" class="doc-link"></a>
colorToAlpha<span class="type-signature"> : <a href="Color.html">Color</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L326">Scene/ImageryLayer.js 326</a>
</div>
</h4>
</div>
<div class="description">
Color value that should be set to transparent.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="colorToAlphaThreshold">
<a href="#colorToAlphaThreshold" class="doc-link"></a>
colorToAlphaThreshold<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L333">Scene/ImageryLayer.js 333</a>
</div>
</h4>
</div>
<div class="description">
Normalized (0-1) threshold for color-to-alpha.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="contrast">
<a href="#contrast" class="doc-link"></a>
contrast<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L192">Scene/ImageryLayer.js 192</a>
</div>
</h4>
</div>
<div class="description">
The contrast of this layer. 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"><a href="ImageryLayer.html#.DEFAULT_CONTRAST"><code>ImageryLayer.DEFAULT_CONTRAST</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="cutoutRectangle">
<a href="#cutoutRectangle" class="doc-link"></a>
cutoutRectangle<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/ImageryLayer.js#L319">Scene/ImageryLayer.js 319</a>
</div>
</h4>
</div>
<div class="description">
Rectangle cutout in this layer of imagery.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="dayAlpha">
<a href="#dayAlpha" class="doc-link"></a>
dayAlpha<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L165">Scene/ImageryLayer.js 165</a>
</div>
</h4>
</div>
<div class="description">
The alpha blending value of this layer on the day side of the globe, with 0.0 representing fully transparent and
1.0 representing fully opaque. This only takes effect when <a href="Globe.html#enableLighting"><code>Globe#enableLighting</code></a> is <code>true</code>.
</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="gamma">
<a href="#gamma" class="doc-link"></a>
gamma<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L229">Scene/ImageryLayer.js 229</a>
</div>
</h4>
</div>
<div class="description">
The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="ImageryLayer.html#.DEFAULT_GAMMA"><code>ImageryLayer.DEFAULT_GAMMA</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="hue">
<a href="#hue" class="doc-link"></a>
hue<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L203">Scene/ImageryLayer.js 203</a>
</div>
</h4>
</div>
<div class="description">
The hue of this layer in radians. 0.0 uses the unmodified imagery color.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="ImageryLayer.html#.DEFAULT_HUE"><code>ImageryLayer.DEFAULT_HUE</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="imageryProvider">
<a href="#imageryProvider" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> imageryProvider<span class="type-signature"> : <a href="ImageryProvider.html">ImageryProvider</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L346">Scene/ImageryLayer.js 346</a>
</div>
</h4>
</div>
<div class="description">
Gets the imagery provider for this layer.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="magnificationFilter">
<a href="#magnificationFilter" class="doc-link"></a>
magnificationFilter<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/ImageryLayer.js#L275">Scene/ImageryLayer.js 275</a>
</div>
</h4>
</div>
<div class="description">
The <a href="global.html#TextureMagnificationFilter"><code>TextureMagnificationFilter</code></a> to apply to this layer.
Possible values are <a href="global.html#TextureMagnificationFilter#.LINEAR"><code>TextureMagnificationFilter.LINEAR</code></a> (the default)
and <a href="global.html#TextureMagnificationFilter#.NEAREST"><code>TextureMagnificationFilter.NEAREST</code></a>.
To take effect, this property must be set immediately after adding the imagery layer.
Once a texture is loaded it won't be possible to change the texture filter used.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="ImageryLayer.html#.DEFAULT_MAGNIFICATION_FILTER"><code>ImageryLayer.DEFAULT_MAGNIFICATION_FILTER</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="minificationFilter">
<a href="#minificationFilter" class="doc-link"></a>
minificationFilter<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/ImageryLayer.js#L256">Scene/ImageryLayer.js 256</a>
</div>
</h4>
</div>
<div class="description">
The <a href="global.html#TextureMinificationFilter"><code>TextureMinificationFilter</code></a> to apply to this layer.
Possible values are <a href="global.html#TextureMinificationFilter#.LINEAR"><code>TextureMinificationFilter.LINEAR</code></a> (the default)
and <a href="global.html#TextureMinificationFilter#.NEAREST"><code>TextureMinificationFilter.NEAREST</code></a>.
To take effect, this property must be set immediately after adding the imagery layer.
Once a texture is loaded it won't be possible to change the texture filter used.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="ImageryLayer.html#.DEFAULT_MINIFICATION_FILTER"><code>ImageryLayer.DEFAULT_MINIFICATION_FILTER</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="nightAlpha">
<a href="#nightAlpha" class="doc-link"></a>
nightAlpha<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L153">Scene/ImageryLayer.js 153</a>
</div>
</h4>
</div>
<div class="description">
The alpha blending value of this layer on the night side of the globe, with 0.0 representing fully transparent and
1.0 representing fully opaque. This only takes effect when <a href="Globe.html#enableLighting"><code>Globe#enableLighting</code></a> is <code>true</code>.
</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="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/ImageryLayer.js#L359">Scene/ImageryLayer.js 359</a>
</div>
</h4>
</div>
<div class="description">
Gets the rectangle of this layer. If this rectangle is smaller than the rectangle of the
<a href="ImageryProvider.html"><code>ImageryProvider</code></a>, only a portion of the imagery provider is shown.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="saturation">
<a href="#saturation" class="doc-link"></a>
saturation<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L215">Scene/ImageryLayer.js 215</a>
</div>
</h4>
</div>
<div class="description">
The saturation of this layer. 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"><a href="ImageryLayer.html#.DEFAULT_SATURATION"><code>ImageryLayer.DEFAULT_SATURATION</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="show">
<a href="#show" class="doc-link"></a>
show<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L289">Scene/ImageryLayer.js 289</a>
</div>
</h4>
</div>
<div class="description">
Determines if this layer is shown.
</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="splitDirection">
<a href="#splitDirection" class="doc-link"></a>
splitDirection<span class="type-signature"> : <a href="global.html#ImagerySplitDirection">ImagerySplitDirection</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L240">Scene/ImageryLayer.js 240</a>
</div>
</h4>
</div>
<div class="description">
The <a href="global.html#ImagerySplitDirection"><code>ImagerySplitDirection</code></a> to apply to this layer.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="ImageryLayer.html#.DEFAULT_SPLIT"><code>ImageryLayer.DEFAULT_SPLIT</code></a></code>
</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/Scene/ImageryLayer.js#L477">Scene/ImageryLayer.js 477</a>
</div>
</h4>
</div>
<div class="description">
Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
release of WebGL resources, instead of relying on the garbage collector to destroy this object.
<br /><br />
Once an object is destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception. Therefore,
assign the return value (<code>undefined</code>) to the object as done in the example.
</div>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
<span class="param-type"><a href="DeveloperError.html">DeveloperError</a></span>
: This object was destroyed, i.e., destroy() was called.
</div>
</li>
</ul>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">imageryLayer = imageryLayer &amp;&amp; imageryLayer.destroy();</code></pre>
<h5>See:</h5>
<ul class="see-list">
<li><a href="ImageryLayer.html#isDestroyed">ImageryLayer#isDestroyed</a></li>
</ul>
</dl>
<div class="nameContainer">
<h4 class="name" id="getViewableRectangle">
<a href="#getViewableRectangle" class="doc-link"></a>
getViewableRectangle<span class="signature">()</span> &rarr; <span class="type-signature returnType">Promise.&lt;<a href="Rectangle.html">Rectangle</a>></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ImageryLayer.js#L500">Scene/ImageryLayer.js 500</a>
</div>
</h4>
</div>
<div class="description">
Computes the intersection of this layer's rectangle with the imagery provider's availability rectangle,
producing the overall bounds of imagery that can be produced by this layer.
</div>
<h5>Returns:</h5>
<div class="param-desc">
A promise to a rectangle which defines the overall bounds of imagery that can be produced by this layer.
</div>
<dl class="details">
<h5>Example:</h5>
<pre><code class="language-javascript">// Zoom to an imagery layer.
imageryLayer.getViewableRectangle().then(function (rectangle) {
return camera.flyTo({
destination: rectangle
});
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="isBaseLayer">
<a href="#isBaseLayer" class="doc-link"></a>
isBaseLayer<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/Scene/ImageryLayer.js#L443">Scene/ImageryLayer.js 443</a>
</div>
</h4>
</div>
<div class="description">
Gets a value indicating whether this layer is the base layer in the
<a href="ImageryLayerCollection.html"><code>ImageryLayerCollection</code></a>. The base layer is the one that underlies all
others. It is special in that it is treated as if it has global rectangle, even if
it actually does not, by stretching the texels at the edges over the entire
globe.
</div>
<h5>Returns:</h5>
<div class="param-desc">
true if this is the base layer; otherwise, false.
</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/Scene/ImageryLayer.js#L457">Scene/ImageryLayer.js 457</a>
</div>
</h4>
</div>
<div class="description">
Returns true if this object was destroyed; otherwise, false.
<br /><br />
If this object was destroyed, it should not be used; calling any function other than
<code>isDestroyed</code> will result in a <a href="DeveloperError.html"><code>DeveloperError</code></a> exception.
</div>
<h5>Returns:</h5>
<div class="param-desc">
True if this object was destroyed; otherwise, false.
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="ImageryLayer.html#destroy">ImageryLayer#destroy</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>