Hierarchy

  • ImageryLayer
    • ILayerExt

Properties

_bId?: string
_bName?: string
alpha: number

The alpha blending value of this layer, with 0.0 representing fully transparent and 1.0 representing fully opaque.

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.

colorToAlpha: Color

Color value that should be set to transparent.

colorToAlphaThreshold: number

Normalized (0-1) threshold for color-to-alpha.

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.

cutoutRectangle: Rectangle

Rectangle cutout in this layer of imagery.

dayAlpha: number

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 Globe#enableLighting is true.

gamma: number

The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.

hue: number

The hue of this layer in radians. 0.0 uses the unmodified imagery color.

imageryProvider: ImageryProvider

Gets the imagery provider for this layer.

magnificationFilter: TextureMagnificationFilter

The TextureMagnificationFilter to apply to this layer. Possible values are TextureMagnificationFilter.LINEAR (the default) and TextureMagnificationFilter.NEAREST.

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.

minificationFilter: TextureMinificationFilter

The TextureMinificationFilter to apply to this layer. Possible values are TextureMinificationFilter.LINEAR (the default) and TextureMinificationFilter.NEAREST.

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.

nightAlpha: number

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 Globe#enableLighting is true.

rectangle: 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.

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.

show: boolean

Determines if this layer is shown.

splitDirection: SplitDirection

The SplitDirection to apply to this layer.

Methods

  • 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 void

    Example

    imageryLayer = imageryLayer && imageryLayer.destroy();
    
  • 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.

    Returns Promise<Rectangle>

    A promise to a rectangle which defines the overall bounds of imagery that can be produced by this layer.

    Example

    // Zoom to an imagery layer.
    imageryLayer.getViewableRectangle().then(function (rectangle) {
    return camera.flyTo({
    destination: rectangle
    });
    });
  • 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 boolean

    true if this is the base layer; otherwise, false.

  • 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 boolean

    True if this object was destroyed; otherwise, false.

Generated using TypeDoc