RasterLayer

fun RasterLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("raster") }, rasterArrayBand: StringValue = StringValue.INITIAL, rasterBrightnessMax: DoubleValue = DoubleValue.INITIAL, rasterBrightnessMaxTransition: Transition = Transition.INITIAL, rasterBrightnessMin: DoubleValue = DoubleValue.INITIAL, rasterBrightnessMinTransition: Transition = Transition.INITIAL, rasterColor: ColorValue = ColorValue.INITIAL, rasterColorMix: DoubleListValue = DoubleListValue.INITIAL, rasterColorMixTransition: Transition = Transition.INITIAL, rasterColorRange: DoubleRangeValue = DoubleRangeValue.INITIAL, rasterColorRangeTransition: Transition = Transition.INITIAL, rasterContrast: DoubleValue = DoubleValue.INITIAL, rasterContrastTransition: Transition = Transition.INITIAL, rasterElevation: DoubleValue = DoubleValue.INITIAL, rasterElevationTransition: Transition = Transition.INITIAL, rasterEmissiveStrength: DoubleValue = DoubleValue.INITIAL, rasterEmissiveStrengthTransition: Transition = Transition.INITIAL, rasterFadeDuration: DoubleValue = DoubleValue.INITIAL, rasterHueRotate: DoubleValue = DoubleValue.INITIAL, rasterHueRotateTransition: Transition = Transition.INITIAL, rasterOpacity: DoubleValue = DoubleValue.INITIAL, rasterOpacityTransition: Transition = Transition.INITIAL, rasterResampling: RasterResamplingValue = RasterResamplingValue.INITIAL, rasterSaturation: DoubleValue = DoubleValue.INITIAL, rasterSaturationTransition: Transition = Transition.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

Raster map textures such as satellite imagery.

See also

Parameters

sourceState

the source that drives this layer.

layerId

the ID of the layer, by default, a random id will be generated with UUID.

rasterArrayBand

Displayed band of raster array source layer

rasterBrightnessMax

Increase or reduce the brightness of the image. The value is the maximum brightness.

rasterBrightnessMaxTransition

Defines the transition of rasterBrightnessMax.

rasterBrightnessMin

Increase or reduce the brightness of the image. The value is the minimum brightness.

rasterBrightnessMinTransition

Defines the transition of rasterBrightnessMin.

rasterColor

Defines a color map by which to colorize a raster layer, parameterized by the ["raster-value"] expression and evaluated at 256 uniformly spaced steps over the range specified by raster-color-range.

rasterColorMix

When raster-color is active, specifies the combination of source RGB channels used to compute the raster value. Computed using the equation mix.r * src.r + mix.g * src.g + mix.b * src.b + mix.a. The first three components specify the mix of source red, green, and blue channels, respectively. The fourth component serves as a constant offset and is not multipled by source alpha. Source alpha is instead carried through and applied as opacity to the colorized result. Default value corresponds to RGB luminosity.

rasterColorMixTransition

Defines the transition of rasterColorMix.

rasterColorRange

When raster-color is active, specifies the range over which raster-color is tabulated. Units correspond to the computed raster value via raster-color-mix.

rasterColorRangeTransition

Defines the transition of rasterColorRange.

rasterContrast

Increase or reduce the contrast of the image.

rasterContrastTransition

Defines the transition of rasterContrast.

rasterElevation

Specifies an uniform elevation from the ground, in meters. Only supported with image sources.

rasterElevationTransition

Defines the transition of rasterElevation.

rasterEmissiveStrength

Controls the intensity of light emitted on the source features.

rasterEmissiveStrengthTransition

Defines the transition of rasterEmissiveStrength.

rasterFadeDuration

Fade duration when a new tile is added.

rasterHueRotate

Rotates hues around the color wheel.

rasterHueRotateTransition

Defines the transition of rasterHueRotate.

rasterOpacity

The opacity at which the image will be drawn.

rasterOpacityTransition

Defines the transition of rasterOpacity.

rasterResampling

The resampling/interpolation method to use for overscaling, also known as texture magnification filter

rasterSaturation

Increase or reduce the saturation of the image.

rasterSaturationTransition

Defines the transition of rasterSaturation.

visibility

Whether this layer is displayed.

minZoom

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

maxZoom

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

sourceLayer

Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources.

filter

An expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The ["feature-state", ...] expression is not supported in filter expressions. The ["pitch"] and ["distance-from-center"] expressions are supported only for filter expressions on the symbol layer.