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:
|
Source:
Scene/ImageryLayer.js, line 151
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 273 -
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 280 -
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 301 -
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 287 -
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 294 -
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 163 -
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 172 -
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 181 -
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 206 -
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 189 -
readonlyimageryProvider :ImageryProvider
-
Gets the imagery provider for this layer.Source: Scene/ImageryLayer.js, line 246
-
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 259 -
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 198 -
show :Boolean
-
Determines if this layer is shown.
-
Default Value:
true
Source: Scene/ImageryLayer.js, line 214
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 thanisDestroyed
will result in aDeveloperError
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:
Source: Scene/ImageryLayer.js, line 347 -
-
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 312 -
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 thanisDestroyed
will result in aDeveloperError
exception.Returns:
True if this object was destroyed; otherwise, false.See:
Source: Scene/ImageryLayer.js, line 326