Skip to main content

Atmosphere

Mapbox spec: atmosphere

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

Atmosphere

props

style

AtmosphereLayerStyleProps

required FIX ME NO DESCRIPTION

styles


range

Name: range

Mapbox spec: range

Description

The start and end distance range in which fog fades from fully transparent to fully opaque. The distance to the point at the center of the map is defined as zero, so that negative range values are closer to the camera, and positive values are farther away.

Type

array<number>

Default Value

[0.5,10]

Minimum

-20

Maximum

20

Expression

Parameters: zoom, measure-light


rangeTransition

Name: rangeTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


color

Name: color

Mapbox spec: color

Description

The color of the atmosphere region immediately below the horizon and within the range and above the horizon and within horizonBlend. Using opacity is recommended only for smoothly transitioning fog on/off as anything less than 100% opacity results in more tiles loaded and drawn.

Type

color

Default Value

#ffffff

Expression

Parameters: zoom, measure-light


colorTransition

Name: colorTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


highColor

Name: highColor

Mapbox spec: high-color

Description

The color of the atmosphere region above the horizon, highColor extends further above the horizon than the color property and its spread can be controlled with horizonBlend. The opacity can be set to 0 to remove the high atmosphere color contribution.

Type

color

Default Value

#245cdf

Expression

Parameters: zoom, measure-light


highColorTransition

Name: highColorTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


spaceColor

Name: spaceColor

Mapbox spec: space-color

Description

The color of the region above the horizon and after the end of the horizonBlend contribution. The opacity can be set to 0 to have a transparent background.

Type

color

Default Value

interpolate,linear,zoom,4,#010b19,7,#367ab9

Expression

Parameters: zoom, measure-light


spaceColorTransition

Name: spaceColorTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


horizonBlend

Name: horizonBlend

Mapbox spec: horizon-blend

Description

Horizon blend applies a smooth fade from the color of the atmosphere to the color of space. A value of zero leaves a sharp transition from atmosphere to space. Increasing the value blends the color of atmosphere into increasingly high angles of the sky.

Type

number

Default Value

interpolate,linear,zoom,4,0.2,7,0.1

Minimum

0

Maximum

1

Expression

Parameters: zoom, measure-light


horizonBlendTransition

Name: horizonBlendTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


starIntensity

Name: starIntensity

Mapbox spec: star-intensity

Description

A value controlling the star intensity where 0 will show no stars and 1 will show stars at their maximum intensity.

Type

number

Default Value

interpolate,linear,zoom,5,0.35,6,0

Minimum

0

Maximum

1

Expression

Parameters: zoom, measure-light


starIntensityTransition

Name: starIntensityTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}