Companion

object Companion

Static variables and methods.

Properties

Link copied to clipboard

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

Link copied to clipboard

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Link copied to clipboard

Whether the raster layer is allowed to drape over terrain and globe. When disabled, the layer is rendered after all draped layers, which can change its position in the layer order. Disabling draping has a performance cost, since the terrain/globe geometry must be rendered again for each such layer. Default value: true.

Link copied to clipboard

Whether the raster layer is allowed to drape over terrain and globe. When disabled, the layer is rendered after all draped layers, which can change its position in the layer order. Disabling draping has a performance cost, since the terrain/globe geometry must be rendered again for each such layer. Default value: true.

Link copied to clipboard

Displayed band of raster array source layer. Defaults to the first band if not set.

Link copied to clipboard

Displayed band of raster array source layer. Defaults to the first band if not set.

Link copied to clipboard

Increase or reduce the brightness of the image. The value is the maximum brightness. Default value: 1. Value range: 0, 1

Link copied to clipboard

Increase or reduce the brightness of the image. The value is the maximum brightness. Default value: 1. Value range: 0, 1

Link copied to clipboard

Transition options for RasterBrightnessMax.

Link copied to clipboard

Increase or reduce the brightness of the image. The value is the minimum brightness. Default value: 0. Value range: 0, 1

Link copied to clipboard

Increase or reduce the brightness of the image. The value is the minimum brightness. Default value: 0. Value range: 0, 1

Link copied to clipboard

Transition options for RasterBrightnessMin.

Link copied to clipboard

When raster-color is active, specifies how the raster value is computed from a non-rasterarray source's channels, using the equation mix.r - src.r + mix.g - src.g + mix.b - src.b + mix.a. The first three components weight the source's red, green, and blue channels; the fourth is a constant offset and is not multiplied by source alpha. Source alpha is carried through and applied as opacity to the colorized result. The default corresponds to RGB luminosity. rasterarray sources ignore this property, as their raster value is decoded directly from the source data. Default value: 0.2126,0.7152,0.0722,0.

Link copied to clipboard

When raster-color is active, specifies how the raster value is computed from a non-rasterarray source's channels, using the equation mix.r - src.r + mix.g - src.g + mix.b - src.b + mix.a. The first three components weight the source's red, green, and blue channels; the fourth is a constant offset and is not multiplied by source alpha. Source alpha is carried through and applied as opacity to the colorized result. The default corresponds to RGB luminosity. rasterarray sources ignore this property, as their raster value is decoded directly from the source data. Default value: 0.2126,0.7152,0.0722,0.

Link copied to clipboard

Transition options for RasterColorMix.

Link copied to clipboard

When raster-color is active, specifies the range of raster values mapped onto the color ramp, from the start of the ramp (low bound) to its end (high bound). For rasterarray sources the raster value is the decoded source data in the source's own units, and the source's stated data range is used when this property is unspecified. For other raster sources the raster value is computed from the source's channels via raster-color-mix. Defaults to [0, 1] when no range is otherwise available.

Link copied to clipboard

When raster-color is active, specifies the range of raster values mapped onto the color ramp, from the start of the ramp (low bound) to its end (high bound). For rasterarray sources the raster value is the decoded source data in the source's own units, and the source's stated data range is used when this property is unspecified. For other raster sources the raster value is computed from the source's channels via raster-color-mix. Defaults to [0, 1] when no range is otherwise available.

Link copied to clipboard

Transition options for RasterColorRange.

Link copied to clipboard
Link copied to clipboard

Increase or reduce the contrast of the image. Default value: 0. Value range: -1, 1

Link copied to clipboard

Increase or reduce the contrast of the image. Default value: 0. Value range: -1, 1

Link copied to clipboard

Transition options for RasterContrast.

Link copied to clipboard

Defines an uniform elevation from the base specified in raster-elevation-reference, in meters. Default value: 0. Minimum value: 0.

Link copied to clipboard

Defines an uniform elevation from the base specified in raster-elevation-reference, in meters. Default value: 0. Minimum value: 0.

Link copied to clipboard

Transition options for RasterElevation.

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0. The unit of rasterEmissiveStrength is in intensity.

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0. The unit of rasterEmissiveStrength is in intensity.

Link copied to clipboard

Transition options for RasterEmissiveStrength.

Link copied to clipboard

Fade duration when a new tile is added. Default value: 300. Minimum value: 0. The unit of rasterFadeDuration is in milliseconds.

Link copied to clipboard

Fade duration when a new tile is added. Default value: 300. Minimum value: 0. The unit of rasterFadeDuration is in milliseconds.

Link copied to clipboard

Rotates hues around the color wheel. Default value: 0. The unit of rasterHueRotate is in degrees.

Link copied to clipboard

Rotates hues around the color wheel. Default value: 0. The unit of rasterHueRotate is in degrees.

Link copied to clipboard

Transition options for RasterHueRotate.

Link copied to clipboard

The opacity at which the image will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard

The opacity at which the image will be drawn. Default value: 1. Value range: 0, 1

Link copied to clipboard

Transition options for RasterOpacity.

Link copied to clipboard

The resampling/interpolation method to use for overscaling, also known as texture magnification filter Default value: "linear".

Link copied to clipboard

The resampling/interpolation method to use for overscaling, also known as texture magnification filter Default value: "linear".

Link copied to clipboard

Increase or reduce the saturation of the image. Default value: 0. Value range: -1, 1

Link copied to clipboard

Increase or reduce the saturation of the image. Default value: 0. Value range: -1, 1

Link copied to clipboard

Transition options for RasterSaturation.

Link copied to clipboard

Visibility of the layer.