RasterLayer

class RasterLayer(val layerId: String, val sourceId: String) : Layer, RasterLayerDsl

Raster map textures such as satellite imagery.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

Link copied to clipboard
fun RasterLayer(layerId: String, sourceId: String)

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
fun bindTo(delegate: MapboxStyleManager)

Bind the layer to the Style.

open override fun bindTo(delegate: MapboxStyleManager, position: LayerPosition?)

Bind the layer to the map controller.

Link copied to clipboard
open override fun maxZoom(maxZoom: Double): RasterLayer

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
open override fun minZoom(minZoom: Double): RasterLayer

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

Link copied to clipboard
open override fun rasterArrayBand(rasterArrayBand: Expression): RasterLayer
open override fun rasterArrayBand(rasterArrayBand: String): RasterLayer

Displayed band of raster array source layer

Link copied to clipboard
open override fun rasterBrightnessMax(rasterBrightnessMax: Expression): RasterLayer
open override fun rasterBrightnessMax(rasterBrightnessMax: Double): RasterLayer

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

Link copied to clipboard

Set the RasterBrightnessMax property transition options

Link copied to clipboard
open override fun rasterBrightnessMin(rasterBrightnessMin: Expression): RasterLayer
open override fun rasterBrightnessMin(rasterBrightnessMin: Double): RasterLayer

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

Link copied to clipboard

Set the RasterBrightnessMin property transition options

Link copied to clipboard
open override fun rasterColor(rasterColor: Expression): RasterLayer

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.

Link copied to clipboard
open override fun rasterColorMix(rasterColorMix: Expression): RasterLayer
open override fun rasterColorMix(rasterColorMix: List<Double>): RasterLayer

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.

Link copied to clipboard

Set the RasterColorMix property transition options

Link copied to clipboard
open override fun rasterColorRange(rasterColorRange: Expression): RasterLayer
open override fun rasterColorRange(rasterColorRange: List<Double>): RasterLayer

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.

Link copied to clipboard

Set the RasterColorRange property transition options

Link copied to clipboard
open override fun rasterContrast(rasterContrast: Expression): RasterLayer
open override fun rasterContrast(rasterContrast: Double): RasterLayer

Increase or reduce the contrast of the image.

Link copied to clipboard

Set the RasterContrast property transition options

Link copied to clipboard
open override fun rasterEmissiveStrength(rasterEmissiveStrength: Expression): RasterLayer
open override fun rasterEmissiveStrength(rasterEmissiveStrength: Double): RasterLayer

Controls the intensity of light emitted on the source features.

Link copied to clipboard

Set the RasterEmissiveStrength property transition options

Link copied to clipboard
open override fun rasterFadeDuration(rasterFadeDuration: Expression): RasterLayer
open override fun rasterFadeDuration(rasterFadeDuration: Double): RasterLayer

Fade duration when a new tile is added.

Link copied to clipboard
open override fun rasterHueRotate(rasterHueRotate: Expression): RasterLayer
open override fun rasterHueRotate(rasterHueRotate: Double): RasterLayer

Rotates hues around the color wheel.

Link copied to clipboard

Set the RasterHueRotate property transition options

Link copied to clipboard
open override fun rasterOpacity(rasterOpacity: Expression): RasterLayer
open override fun rasterOpacity(rasterOpacity: Double): RasterLayer

The opacity at which the image will be drawn.

Link copied to clipboard

Set the RasterOpacity property transition options

Link copied to clipboard
open override fun rasterResampling(rasterResampling: Expression): RasterLayer
open override fun rasterResampling(rasterResampling: RasterResampling): RasterLayer

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

Link copied to clipboard
open override fun rasterSaturation(rasterSaturation: Expression): RasterLayer
open override fun rasterSaturation(rasterSaturation: Double): RasterLayer

Increase or reduce the saturation of the image.

Link copied to clipboard

Set the RasterSaturation property transition options

Link copied to clipboard
open override fun slot(slot: String): RasterLayer

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

Link copied to clipboard
open override fun sourceLayer(sourceLayer: String): RasterLayer

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

Link copied to clipboard
open override fun visibility(visibility: Expression): RasterLayer
open override fun visibility(visibility: Visibility): RasterLayer

Whether this layer is displayed.

Properties

Link copied to clipboard
open override val layerId: String
Link copied to clipboard
open override val maxZoom: Double?

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
open override val minZoom: Double?

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

Link copied to clipboard

Displayed band of raster array source layer

Link copied to clipboard

Displayed band of raster array source layer

Link copied to clipboard

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

Link copied to clipboard

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

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.

Link copied to clipboard

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

Link copied to clipboard

Transition options for RasterBrightnessMin.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Transition options for RasterColorMix.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Transition options for RasterColorRange.

Link copied to clipboard

Increase or reduce the contrast of the image.

Link copied to clipboard

Increase or reduce the contrast of the image.

Link copied to clipboard

Transition options for RasterContrast.

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

Controls the intensity of light emitted on the source features.

Link copied to clipboard

Transition options for RasterEmissiveStrength.

Link copied to clipboard

Fade duration when a new tile is added.

Link copied to clipboard

Fade duration when a new tile is added.

Link copied to clipboard

Rotates hues around the color wheel.

Link copied to clipboard

Rotates hues around the color wheel.

Link copied to clipboard

Transition options for RasterHueRotate.

Link copied to clipboard

The opacity at which the image will be drawn.

Link copied to clipboard

The opacity at which the image will be drawn.

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

Link copied to clipboard

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

Link copied to clipboard

Increase or reduce the saturation of the image.

Link copied to clipboard

Increase or reduce the saturation of the image.

Link copied to clipboard

Transition options for RasterSaturation.

Link copied to clipboard
open override val slot: String?

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

Link copied to clipboard
Link copied to clipboard

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.

Link copied to clipboard

Whether this layer is displayed.

Extensions

Link copied to clipboard

Get the persistent property as Boolean.