ImageryLayer - Cesium Documentation

# ImageryLayer

#### new ImageryLayer(imageryProvider, options)

  An imagery layer that displays tiled image data from a single imagery provider on a `Globe`.

  Name | Type | Description
  --- | --- | ---
  `imageryProvider` | ImageryProvider | The imagery provider to use.

  `options`

  Object

  optional Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `rectangle` | Rectangle | `imageryProvider.rectangle` | optional The rectangle of the layer. This rectangle can limit the visible portion of the imagery provider.
  `alpha` | Number | function | `1.0` | optional 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 `function(frameState, layer, x, y, level)`. 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.
  `brightness` | Number | function | `1.0` | optional 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 `function(frameState, layer, x, y, level)`. 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.
  `contrast` | Number | function | `1.0` | optional 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 `function(frameState, layer, x, y, level)`. 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.
  `hue` | Number | function | `0.0` | optional 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 `function(frameState, layer, x, y, level)`. 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.
  `saturation` | Number | function | `1.0` | optional 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 `function(frameState, layer, x, y, level)`. 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.
  `gamma` | Number | function | `1.0` | optional 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 `function(frameState, layer, x, y, level)`. 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.
  `show` | Boolean | `true` | optional True if the layer is shown; otherwise, false.
  `maximumAnisotropy` | Number | `maximum supported` | optional 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.
  `minimumTerrainLevel` | Number |  | optional 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.
  `maximumTerrainLevel` | Number |  | optional 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.

  Source: Scene/ImageryLayer.js, line 135

### Members

#### staticImageryLayer.DEFAULT_BRIGHTNESS :Number

  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.
  Default Value: `1.0`
  Source: Scene/ImageryLayer.js, line 257

#### staticImageryLayer.DEFAULT_CONTRAST :Number

  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.
  Default Value: `1.0`
  Source: Scene/ImageryLayer.js, line 264

#### staticImageryLayer.DEFAULT_GAMMA :Number

  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.
  Default Value: `1.0`
  Source: Scene/ImageryLayer.js, line 285

#### staticImageryLayer.DEFAULT_HUE :Number

  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.
  Default Value: `0.0`
  Source: Scene/ImageryLayer.js, line 271

#### staticImageryLayer.DEFAULT_SATURATION :Number

  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.
  Default Value: `1.0`
  Source: Scene/ImageryLayer.js, line 278

#### alpha :Number

  The alpha blending value of this layer, with 0.0 representing fully transparent and 1.0 representing fully opaque.
  Default Value: `1.0`
  Source: Scene/ImageryLayer.js, line 147

#### brightness :Number

  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.
  Default Value: ``ImageryLayer.DEFAULT_BRIGHTNESS``
  Source: Scene/ImageryLayer.js, line 156

#### contrast :Number

  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.
  Default Value: ``ImageryLayer.DEFAULT_CONTRAST``
  Source: Scene/ImageryLayer.js, line 165

#### gamma :Number

  The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.
  Default Value: ``ImageryLayer.DEFAULT_GAMMA``
  Source: Scene/ImageryLayer.js, line 190

#### hue :Number

  The hue of this layer in radians. 0.0 uses the unmodified imagery color.
  Default Value: ``ImageryLayer.DEFAULT_HUE``
  Source: Scene/ImageryLayer.js, line 173

#### readonlyimageryProvider :ImageryProvider

  Gets the imagery provider for this layer.
  Source: Scene/ImageryLayer.js, line 230

#### readonlyrectangle :Rectangle

  Gets the rectangle of this layer. If this rectangle is smaller than the rectangle of the `ImageryProvider`, only a portion of the imagery provider is shown.
  Source: Scene/ImageryLayer.js, line 243

#### saturation :Number

  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.
  Default Value: ``ImageryLayer.DEFAULT_SATURATION``
  Source: Scene/ImageryLayer.js, line 182

#### show :Boolean

  Determines if this layer is shown.
  Default Value: `true`
  Source: Scene/ImageryLayer.js, line 198

### Methods

#### destroy() → undefined

  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.
  Once an object is destroyed, it should not be used; calling any function other than `isDestroyed` will result in a `DeveloperError` exception. Therefore, assign the return value (`undefined`) to the object as done in the example.

  ##### Returns:

  ##### Throws:

  - DeveloperError : This object was destroyed, i.e., destroy() was called.

  ##### Example:

      imageryLayer = imageryLayer && imageryLayer.destroy();

  ##### See:

  - ImageryLayer#isDestroyed
  Source: Scene/ImageryLayer.js, line 331

#### isBaseLayer() → Boolean

  Gets a value indicating whether this layer is the base layer in the `ImageryLayerCollection`. 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.

  ##### Returns:

  true if this is the base layer; otherwise, false.
  Source: Scene/ImageryLayer.js, line 296

#### isDestroyed() → Boolean

  Returns true if this object was destroyed; otherwise, false.
  If this object was destroyed, it should not be used; calling any function other than `isDestroyed` will result in a `DeveloperError` exception.

  ##### Returns:

  True if this object was destroyed; otherwise, false.

  ##### See:

  - ImageryLayer#destroy
  Source: Scene/ImageryLayer.js, line 310