Skip to main content

<RasterLayer />

Props​

PropTypeDefaultRequiredDescription
styleRasterLayerStylenonefalseCustomizable style attributes
sourceIDFIX ME UNKNOWN TYPEMLRNModule.StyleSource.DefaultSourceIDfalseFIX ME NO DESCRIPTION

Styles​

visibility​

Whether this layer is displayed.

Type
enum
Default Value
visible
Supported Values

  • visible: The layer is shown.

  • none: The layer is not shown.

rasterOpacity​

The opacity at which the image will be drawn.

Type
number
Default Value
1
Minimum
0
Maximum
1
Expression Parameters
zoom

rasterOpacityTransition​

The transition affecting any changes to this layer’s rasterOpacity property.

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

rasterHueRotate​

Rotates hues around the color wheel.

Type
number
Default Value
0
Units
degrees
Expression Parameters
zoom

rasterHueRotateTransition​

The transition affecting any changes to this layer’s rasterHueRotate property.

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

rasterBrightnessMin​

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

Type
number
Default Value
0
Minimum
0
Maximum
1
Expression Parameters
zoom

rasterBrightnessMinTransition​

The transition affecting any changes to this layer’s rasterBrightnessMin property.

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

rasterBrightnessMax​

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

Type
number
Default Value
1
Minimum
0
Maximum
1
Expression Parameters
zoom

rasterBrightnessMaxTransition​

The transition affecting any changes to this layer’s rasterBrightnessMax property.

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

rasterSaturation​

Increase or reduce the saturation of the image.

Type
number
Default Value
0
Minimum
-1
Maximum
1
Expression Parameters
zoom

rasterSaturationTransition​

The transition affecting any changes to this layer’s rasterSaturation property.

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

rasterContrast​

Increase or reduce the contrast of the image.

Type
number
Default Value
0
Minimum
-1
Maximum
1
Expression Parameters
zoom

rasterContrastTransition​

The transition affecting any changes to this layer’s rasterContrast property.

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

rasterResampling​

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

Type
enum
Default Value
linear
Supported Values

  • linear: (Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled

  • nearest: Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled

Expression Parameters
zoom

rasterFadeDuration​

Fade duration when a new tile is added, or when a video is started or its coordinates are updated.

Type
number
Default Value
300
Units
milliseconds
Minimum
0
Expression Parameters
zoom