RasterLayerState

The state holder for RasterLayer's layer properties.

See also

Constructors

Link copied to clipboard

Construct an default RasterLayerState.

Properties

Link copied to clipboard

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.

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. Value range: 0, 24

Link copied to clipboard

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

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

Defines the transition of rasterBrightnessMax. Default value: 1. 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

Defines the transition of rasterBrightnessMin. Default value: 0. Value range: 0, 1

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. Default value: 0.2126,0.7152,0.0722,0.

Link copied to clipboard

Defines the transition of rasterColorMix. Default value: 0.2126,0.7152,0.0722,0.

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. For rasterarray sources, if raster-color-range is unspecified, the source's stated data range is used.

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

Defines the transition of rasterContrast. Default value: 0. Value range: -1, 1

Link copied to clipboard

Specifies an uniform elevation from the ground, in meters. Default value: 0. Minimum value: 0.

Link copied to clipboard

Defines the transition of rasterElevation. Default value: 0. Minimum value: 0.

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

Link copied to clipboard

Defines the transition of rasterEmissiveStrength. Default value: 0. Minimum value: 0.

Link copied to clipboard

Fade duration when a new tile is added. Default value: 300. Minimum value: 0.

Link copied to clipboard

Rotates hues around the color wheel. Default value: 0.

Link copied to clipboard

Defines the transition of rasterHueRotate. Default value: 0.

Link copied to clipboard

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

Link copied to clipboard

Defines the transition of rasterOpacity. Default value: 1. Value range: 0, 1

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

Defines the transition of rasterSaturation. Default value: 0. Value range: -1, 1

Link copied to clipboard

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

Link copied to clipboard

Whether this layer is displayed. Default value: "visible".