Skip to main content

BackgroundLayer

Mapbox spec: background

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

BackgroundLayer

props​

id​

string

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

existing​

boolean

The id refers to an 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.

style​

BackgroundLayerStyleProps

Customizable style attributes

styles​

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: ``

backgroundPitchAlignment​

Name: backgroundPitchAlignment

Mapbox spec: background-pitch-alignment

Description​

Orientation of background layer.

Type​

enum

Default Value​

map

Supported Values​

map - The background is aligned to the plane of the map.
viewport - The background is aligned to the plane of the viewport, covering the whole screen. Note: This mode disables the automatic reordering of the layer when terrain or globe projection is used.

Expression​

Parameters: ``

backgroundColor​

Name: backgroundColor

Mapbox spec: background-color

Description​

The color with which the background will be drawn.

Type​

color

Default Value​

#000000

Disabled By​

backgroundPattern

Expression​

Parameters: zoom, measure-light

backgroundColorTransition​

Name: backgroundColorTransition

Description​

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

Type​

{ duration, delay }

Units​

milliseconds

Default Value​

{duration: 300, delay: 0}

backgroundPattern​

Name: backgroundPattern

Mapbox spec: background-pattern

Description​

Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoomDependent expressions will be evaluated only at integer zoom levels.

Type​

resolvedImage

Expression​

Parameters: zoom

backgroundOpacity​

Name: backgroundOpacity

Mapbox spec: background-opacity

Description​

The opacity at which the background will be drawn.

Type​

number

Default Value​

1

Minimum​

0

Maximum​

1

Expression​

Parameters: zoom

backgroundOpacityTransition​

Name: backgroundOpacityTransition

Description​

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

Type​

{ duration, delay }

Units​

milliseconds

Default Value​

{duration: 300, delay: 0}

backgroundEmissiveStrength​

Name: backgroundEmissiveStrength

Mapbox spec: background-emissive-strength

Description​

Controls the intensity of light emitted on the source features.

Type​

number

Default Value​

0

Units​

intensity

Minimum​

0

Requires​

lights

Expression​

Parameters: zoom, measure-light

backgroundEmissiveStrengthTransition​

Name: backgroundEmissiveStrengthTransition

Description​

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

Type​

{ duration, delay }

Units​

milliseconds

Default Value​

{duration: 300, delay: 0}