Mapbox spec: raster
import { RasterLayer } from '@rnmapbox/maps';
RasterLayerstringrequired A string that uniquely identifies the source in the style to which it is added.
booleanThe id refers to an existing layer in the style. Does not create a new layer.
stringThe source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined. Inferred from parent source only if the layer is a direct child to it.
defaults to: Mapbox.StyleSource.DefaultSourceID
stringIdentifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.
stringInserts a layer above aboveLayerID.
stringInserts a layer below belowLayerID
numberInserts a layer at a specified index
FilterExpressionFilter only the features in the source layer that satisfy a condition that you define
numberThe minimum zoom level at which the layer gets parsed and appears.
numberThe maximum zoom level at which the layer gets parsed and appears.
'bottom' | 'middle' | 'top'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.
v11 only
RasterLayerStylePropsrequired Customizable style attributes
- visibility
- rasterOpacity
- rasterColor
- rasterColorMix
- rasterColorRange
- rasterHueRotate
- rasterBrightnessMin
- rasterBrightnessMax
- rasterSaturation
- rasterContrast
- rasterResampling
- rasterFadeDuration
- rasterEmissiveStrength
- rasterArrayBand
- rasterElevation
Name: visibility
Mapbox spec: visibility
Whether this layer is displayed.
enum
visible
visible - The layer is shown.
none - The layer is not shown.
Parameters: ``
Name: rasterOpacity
Mapbox spec: raster-opacity
The opacity at which the image will be drawn.
number
1
0
1
Parameters: zoom
Name: rasterOpacityTransition
The transition affecting any changes to this layer’s rasterOpacity property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: rasterColor
Mapbox spec: raster-color
Defines a color map by which to colorize a raster layer, parameterized by the ["rasterValue"] expression and evaluated at 256 uniformly spaced steps over the range specified by rasterColorRange.
color
Parameters: raster-value
Name: rasterColorMix
Mapbox spec: raster-color-mix
When rasterColor 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.
array<number>
[0.2126,0.7152,0.0722,0]
rasterColor
Parameters: zoom
Name: rasterColorMixTransition
The transition affecting any changes to this layer’s rasterColorMix property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: rasterColorRange
Mapbox spec: raster-color-range
When rasterColor is active, specifies the range over which rasterColor is tabulated. Units correspond to the computed raster value via rasterColorMix. For rasterarray sources, if rasterColorRange is unspecified, the source's stated data range is used.
array<number>
rasterColor
Parameters: zoom
Name: rasterColorRangeTransition
The transition affecting any changes to this layer’s rasterColorRange property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: rasterHueRotate
Mapbox spec: raster-hue-rotate
Rotates hues around the color wheel.
number
0
degrees
Parameters: zoom
Name: rasterHueRotateTransition
The transition affecting any changes to this layer’s rasterHueRotate property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: rasterBrightnessMin
Mapbox spec: raster-brightness-min
Increase or reduce the brightness of the image. The value is the minimum brightness.
number
0
0
1
Parameters: zoom
Name: rasterBrightnessMinTransition
The transition affecting any changes to this layer’s rasterBrightnessMin property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: rasterBrightnessMax
Mapbox spec: raster-brightness-max
Increase or reduce the brightness of the image. The value is the maximum brightness.
number
1
0
1
Parameters: zoom
Name: rasterBrightnessMaxTransition
The transition affecting any changes to this layer’s rasterBrightnessMax property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: rasterSaturation
Mapbox spec: raster-saturation
Increase or reduce the saturation of the image.
number
0
-1
1
Parameters: zoom
Name: rasterSaturationTransition
The transition affecting any changes to this layer’s rasterSaturation property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: rasterContrast
Mapbox spec: raster-contrast
Increase or reduce the contrast of the image.
number
0
-1
1
Parameters: zoom
Name: rasterContrastTransition
The transition affecting any changes to this layer’s rasterContrast property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: rasterResampling
Mapbox spec: raster-resampling
The resampling/interpolation method to use for overscaling, also known as texture magnification filter
enum
linear
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
Parameters: zoom
Name: rasterFadeDuration
Mapbox spec: raster-fade-duration
Fade duration when a new tile is added.
number
300
milliseconds
0
Parameters: zoom
Name: rasterEmissiveStrength
Mapbox spec: raster-emissive-strength
Controls the intensity of light emitted on the source features.
number
0
intensity
0
lights
Parameters: zoom, measure-light
Name: rasterEmissiveStrengthTransition
The transition affecting any changes to this layer’s rasterEmissiveStrength property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: rasterArrayBand
Mapbox spec: raster-array-band
Displayed band of raster array source layer. Defaults to the first band if not set.
string
Name: rasterElevation
Mapbox spec: raster-elevation
Specifies an uniform elevation from the ground, in meters.
number
0
0
Parameters: zoom
Name: rasterElevationTransition
The transition affecting any changes to this layer’s rasterElevation property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}