RasterLayer

Mapbox spec: raster

import { RasterLayer } from '@rnmapbox/maps';

RasterLayer

props

id

string

required A string that uniquely identifies the source in the style to which it is added.

existing

boolean

The id refers to en existing layer in the style. Does not create a new layer.

sourceID

string

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. Inferred from parent source only if the layer is a direct child to it.

defaults to: Mapbox.StyleSource.DefaultSourceID

sourceLayerID

string

Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.

aboveLayerID

string

Inserts a layer above aboveLayerID.

belowLayerID

string

Inserts a layer below belowLayerID

layerIndex

number

Inserts a layer at a specified index

filter

FilterExpression

Filter only the features in the source layer that satisfy a condition that you define

minZoomLevel

number

The minimum zoom level at which the layer gets parsed and appears.

maxZoomLevel

number

The maximum zoom level at which the layer gets parsed and appears.

slot

'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

style

RasterLayerStyleProps

required Customizable style attributes

styles

• visibility
  
• rasterOpacity
  
• rasterHueRotate
  
• rasterBrightnessMin
  
• rasterBrightnessMax
  
• rasterSaturation
  
• rasterContrast
  
• rasterResampling
  
• rasterFadeDuration
  

---

visibility

Name: visibility

Mapbox spec: visibility

Description

Whether this layer is displayed.

Type

enum

Default Value

visible

Supported Values

visible - The layer is shown.
none - The layer is not shown.

Expression

Parameters: ``

---

rasterOpacity

Name: rasterOpacity

Mapbox spec: raster-opacity

Description

The opacity at which the image will be drawn.

Type

number

Default Value

1

Minimum

0

Maximum

1

Expression

Parameters: zoom

---

rasterOpacityTransition

Name: rasterOpacityTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

---

rasterHueRotate

Name: rasterHueRotate

Mapbox spec: raster-hue-rotate

Description

Rotates hues around the color wheel.

Type

number

Default Value

0

Units

degrees

Expression

Parameters: zoom

---

rasterHueRotateTransition

Name: rasterHueRotateTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

---

rasterBrightnessMin

Name: rasterBrightnessMin

Mapbox spec: raster-brightness-min

Description

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

Name: rasterBrightnessMinTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

---

rasterBrightnessMax

Name: rasterBrightnessMax

Mapbox spec: raster-brightness-max

Description

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

Name: rasterBrightnessMaxTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

---

rasterSaturation

Name: rasterSaturation

Mapbox spec: raster-saturation

Description

Increase or reduce the saturation of the image.

Type

number

Default Value

0

Minimum

-1

Maximum

1

Expression

Parameters: zoom

---

rasterSaturationTransition

Name: rasterSaturationTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

---

rasterContrast

Name: rasterContrast

Mapbox spec: raster-contrast

Description

Increase or reduce the contrast of the image.

Type

number

Default Value

0

Minimum

-1

Maximum

1

Expression

Parameters: zoom

---

rasterContrastTransition

Name: rasterContrastTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

---

rasterResampling

Name: rasterResampling

Mapbox spec: raster-resampling

Description

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

Name: rasterFadeDuration

Mapbox spec: raster-fade-duration

Description

Fade duration when a new tile is added.

Type

number

Default Value

300

Units

milliseconds

Minimum

0

Expression

Parameters: zoom