mapbox-maps-android/com.mapbox.maps.extension.compose.style.layers.generated/RasterLayerState

RasterLayerState

@Stable

class RasterLayerState

The state holder for RasterLayer's layer properties.

Constructors

RasterLayerState

fun RasterLayerState()

Construct an default RasterLayerState.

Properties

filter

var filter: 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.

interactionsState

@MapboxExperimental

var interactionsState: LayerInteractionsState

The interactions associated with this layer.

maxZoom

var maxZoom: LongValue

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

minZoom

var minZoom: LongValue

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden. Value range: 0, 24

rasterAllowDraping

@MapboxExperimental

var rasterAllowDraping: BooleanValue

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.

rasterArrayBand

@MapboxExperimental

var rasterArrayBand: StringValue

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

rasterBrightnessMax

var rasterBrightnessMax: DoubleValue

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

rasterBrightnessMaxTransition

var rasterBrightnessMaxTransition: Transition

Defines the transition of rasterBrightnessMax.

rasterBrightnessMin

var rasterBrightnessMin: DoubleValue

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

rasterBrightnessMinTransition

var rasterBrightnessMinTransition: Transition

Defines the transition of rasterBrightnessMin.

rasterColor

var rasterColor: ColorValue

Defines the color ramp used to colorize a raster layer, parameterized by the ["raster-value"] expression and evaluated over the range specified by raster-color-range. Raster values are spaced evenly across the range by default.

rasterColorMix

var rasterColorMix: DoubleListValue

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.

rasterColorMixTransition

var rasterColorMixTransition: Transition

Defines the transition of rasterColorMix.

rasterColorRange

var rasterColorRange: DoubleRangeValue

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.

rasterColorRangeTransition

var rasterColorRangeTransition: Transition

Defines the transition of rasterColorRange.

rasterColorUseTheme

@MapboxExperimental

var rasterColorUseTheme: StringValue

Overrides applying of color theme for rasterColor if "none" is set. To follow default theme "default" should be set. Default value: "default".

rasterContrast

var rasterContrast: DoubleValue

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

rasterContrastTransition

var rasterContrastTransition: Transition

Defines the transition of rasterContrast.

rasterElevation

@MapboxExperimental

var rasterElevation: DoubleValue

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

rasterElevationTransition

@MapboxExperimental

var rasterElevationTransition: Transition

Defines the transition of rasterElevation.

rasterEmissiveStrength

var rasterEmissiveStrength: DoubleValue

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

rasterEmissiveStrengthTransition

var rasterEmissiveStrengthTransition: Transition

Defines the transition of rasterEmissiveStrength.

rasterFadeDuration

var rasterFadeDuration: DoubleValue

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

rasterHueRotate

var rasterHueRotate: DoubleValue

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

rasterHueRotateTransition

var rasterHueRotateTransition: Transition

Defines the transition of rasterHueRotate.