| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
| id | string |
none |
true |
A string that uniquely identifies the source in the style to which it is added. |
| sourceID | string |
MapboxGL.StyleSource.DefaultSourceID |
false |
The 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. |
| sourceLayerID | string |
none |
false |
Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
| aboveLayerID | string |
none |
false |
Inserts a layer above aboveLayerID. |
| belowLayerID | string |
none |
false |
Inserts a layer below belowLayerID |
| layerIndex | number |
none |
false |
Inserts a layer at a specified index |
| filter | array |
none |
false |
Filter only the features in the source layer that satisfy a condition that you define |
| minZoomLevel | number |
none |
false |
The minimum zoom level at which the layer gets parsed and appears. |
| maxZoomLevel | number |
none |
false |
The maximum zoom level at which the layer gets parsed and appears. |
| style | union |
none |
false |
Customizable style attributes |
- visibility
- rasterOpacity
- rasterHueRotate
- rasterBrightnessMin
- rasterBrightnessMax
- rasterSaturation
- rasterContrast
- rasterResampling
- rasterFadeDuration
visibility
Whether this layer is displayed.
enum
visible
visible - The layer is shown.
none - The layer is not shown.
rasterOpacity
The opacity at which the image will be drawn.
number
1
0
1
Parameters: zoom
rasterOpacityTransition
The transition affecting any changes to this layer’s rasterOpacity propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
rasterHueRotate
Rotates hues around the color wheel.
number
0
degrees
Parameters: zoom
rasterHueRotateTransition
The transition affecting any changes to this layer’s rasterHueRotate propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
rasterBrightnessMin
Increase or reduce the brightness of the image. The value is the minimum brightness.
number
0
0
1
Parameters: zoom
rasterBrightnessMinTransition
The transition affecting any changes to this layer’s rasterBrightnessMin propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
rasterBrightnessMax
Increase or reduce the brightness of the image. The value is the maximum brightness.
number
1
0
1
Parameters: zoom
rasterBrightnessMaxTransition
The transition affecting any changes to this layer’s rasterBrightnessMax propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
rasterSaturation
Increase or reduce the saturation of the image.
number
0
-1
1
Parameters: zoom
rasterSaturationTransition
The transition affecting any changes to this layer’s rasterSaturation propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
rasterContrast
Increase or reduce the contrast of the image.
number
0
-1
1
Parameters: zoom
rasterContrastTransition
The transition affecting any changes to this layer’s rasterContrast propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
rasterResampling
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
rasterFadeDuration
Fade duration when a new tile is added.
number
300
milliseconds
0
Parameters: zoom