ImageryLayer

Members

Default Value: 0.004

Default Value: 1.0

Default Value: 1.0

Default Value: 1.0

Default Value: 0.0

Default Value: TextureMagnificationFilter.LINEAR

Default Value: TextureMinificationFilter.LINEAR

Default Value: 1.0

Default Value: SplitDirection.NONE

Default Value: 1.0

Default Value: ImageryLayer.DEFAULT_BRIGHTNESS

Default Value: ImageryLayer.DEFAULT_CONTRAST

Default Value: 1.0

Default Value: ImageryLayer.DEFAULT_GAMMA

Default Value: ImageryLayer.DEFAULT_HUE

Default Value: ImageryLayer.DEFAULT_MAGNIFICATION_FILTER

Default Value: ImageryLayer.DEFAULT_MINIFICATION_FILTER

Default Value: 1.0

Default Value: ImageryLayer.DEFAULT_SATURATION

Default Value: true

Default Value: ImageryLayer.DEFAULT_SPLIT

Methods

Returns:

Examples:

// Create a new base layer
const viewer = new Cesium.Viewer("cesiumContainer", {
  baseLayer: Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
});

// Add a new transparent layer
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
imageryLayer.alpha = 0.5;
viewer.imageryLayers.add(imageryLayer);

// Handle loading events
const imageryLayer = Cesium.ImageryLayer.fromProviderAsync(Cesium.IonImageryProvider.fromAssetId(3812));
viewer.imageryLayers.add(imageryLayer);

imageryLayer.readyEvent.addEventListener(provider => {
  imageryLayer.provider.errorEvent.addEventListener(error => {
    alert(`Encountered an error while loading imagery tiles! ${error}`);
  });
});

imageryLayer.errorEvent.addEventListener(error => {
  alert(`Encountered an error while creating an imagery layer! ${error}`);
});

See:

• ImageryLayer.errorEvent
• ImageryLayer.readyEvent
• ImageryLayer.provider
• ImageryLayer.fromWorldImagery

Returns:

Examples:

// Add a new transparent layer
const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
imageryLayer.alpha = 0.5;
viewer.imageryLayers.add(imageryLayer);

// Handle loading events
const imageryLayer = Cesium.ImageryLayer.fromWorldImagery();
viewer.imageryLayers.add(imageryLayer);

imageryLayer.readyEvent.addEventListener(provider => {
  imageryLayer.provider.errorEvent.addEventListener(error => {
    alert(`Encountered an error while loading imagery tiles! ${error}`);
  });
});

imageryLayer.errorEvent.addEventListener(error => {
  alert(`Encountered an error while creating an imagery layer! ${error}`);
});

See:

• ImageryLayer.errorEvent
• ImageryLayer.readyEvent
• ImageryLayer.provider

Throws:

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

Example:

imageryLayer = imageryLayer && imageryLayer.destroy();

See:

• ImageryLayer#isDestroyed

Returns:

Example:

// Zoom to an imagery layer.
const imageryRectangle = imageryLayer.getImageryRectangle();
scene.camera.flyTo({
    destination: rectangle
});

Returns:

Example:

// Zoom to an imagery layer.
imageryLayer.getViewableRectangle().then(function (rectangle) {
    return camera.flyTo({
        destination: rectangle
    });
});

Returns:

Returns:

See:

• ImageryLayer#destroy

Type Definitions

Properties:

Name	Type	Attributes	Default	Description
rectangle	Rectangle	<optional>	imageryProvider.rectangle	The rectangle of the layer. This rectangle can limit the visible portion of the imagery provider.
alpha	number | function	<optional>	1.0	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.
nightAlpha	number | function	<optional>	1.0	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 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. This only takes effect when enableLighting is true.
dayAlpha	number | function	<optional>	1.0	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 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. This only takes effect when enableLighting is true.
brightness	number | function	<optional>	1.0	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	<optional>	1.0	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	<optional>	0.0	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	<optional>	1.0	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	<optional>	1.0	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.
splitDirection	SplitDirection | function	<optional>	SplitDirection.NONE	The SplitDirection split to apply to this layer.
minificationFilter	TextureMinificationFilter	<optional>	TextureMinificationFilter.LINEAR	The texture minification filter to apply to this layer. Possible values are TextureMinificationFilter.LINEAR and TextureMinificationFilter.NEAREST.
magnificationFilter	TextureMagnificationFilter	<optional>	TextureMagnificationFilter.LINEAR	The texture minification filter to apply to this layer. Possible values are TextureMagnificationFilter.LINEAR and TextureMagnificationFilter.NEAREST.
show	boolean	<optional>	true	True if the layer is shown; otherwise, false.
maximumAnisotropy	number	<optional>	maximum supported	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.
cutoutRectangle	Rectangle	<optional>		Cartographic rectangle for cutting out a portion of this ImageryLayer.
colorToAlpha	Color	<optional>		Color to be used as alpha.
colorToAlphaThreshold	number	<optional>	0.004	Threshold for color-to-alpha.

This:

• ImageryLayer

This:

• ImageryLayer

Properties:

Name	Type	Attributes	Default	Description
options.style	IonWorldImageryStyle	<optional>	IonWorldImageryStyle	The style of base imagery, only AERIAL, AERIAL_WITH_LABELS, and ROAD are currently supported.