WorldImageryConstructorOptions

Initialization options for ImageryLayer.fromWorldImagery

See also

Properties

Link copied to clipboard
abstract var alpha: Double?

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. Default value - 1.0

Link copied to clipboard
abstract var brightness: Double?

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. Default value - 1.0

Link copied to clipboard
abstract var colorToAlpha: Color?

Color to be used as alpha.

Link copied to clipboard

Threshold for color-to-alpha. Default value - 0.004

Link copied to clipboard
abstract var contrast: Double?

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. Default value - 1.0

Link copied to clipboard
abstract var cutoutRectangle: Rectangle?

Cartographic rectangle for cutting out a portion of this ImageryLayer.

Link copied to clipboard
abstract var dayAlpha: Double?

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. Default value - 1.0

Link copied to clipboard
abstract var gamma: Double?

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. Default value - 1.0

Link copied to clipboard
abstract var hue: Double?

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. Default value - 0.0

Link copied to clipboard

The texture minification filter to apply to this layer. Possible values are TextureMagnificationFilter.LINEAR and TextureMagnificationFilter.NEAREST. Default value - TextureMagnificationFilter.LINEAR

Link copied to clipboard
abstract var maximumAnisotropy: Double?

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. Default value - maximum supported

Link copied to clipboard
abstract var maximumTerrainLevel: Int?

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.

Link copied to clipboard

The texture minification filter to apply to this layer. Possible values are TextureMinificationFilter.LINEAR and TextureMinificationFilter.NEAREST. Default value - TextureMinificationFilter.LINEAR

Link copied to clipboard
abstract var minimumTerrainLevel: Int?

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.

Link copied to clipboard
abstract var nightAlpha: Double?

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. Default value - 1.0

Link copied to clipboard
abstract var rectangle: Rectangle?

The rectangle of the layer. This rectangle can limit the visible portion of the imagery provider. Default value - imageryProvider.rectangle

Link copied to clipboard
abstract var saturation: Double?

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. Default value - 1.0

Link copied to clipboard
abstract var show: Boolean?

True if the layer is shown; otherwise, false. Default value - true

Link copied to clipboard

The SplitDirection split to apply to this layer. Default value - SplitDirection.NONE