Light
Mapbox spec: light
import { Light } from '@rnmapbox/maps';
Light
Light represents the light source for extruded geometries
props
style
LightLayerStyleProps
required Customizable style attributes
styles
anchor
Name: anchor
Mapbox spec: anchor
Description
Whether extruded geometries are lit relative to the map or viewport.
Type
enum
Default Value
viewport
Supported Values
map - The position of the light source is aligned to the rotation of the map.
viewport - The position of the light source is aligned to the rotation of the viewport.
Expression
Parameters: zoom
position
Name: position
Mapbox spec: position
Description
Position of the light source relative to lit (extruded) geometries, in [r radial coordinate, a azimuthal angle, p polar angle] where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0° (0° when light.anchor is set to viewport corresponds to the top of the viewport, or 0° when light.anchor is set to map corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0°, directly above, to 180°, directly below).
Type
array<number>
Default Value
[1.15,210,30]
Expression
Parameters: zoom
positionTransition
Name: positionTransition
Description
The transition affecting any changes to this layer’s position property.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
color
Name: color
Mapbox spec: color
Description
Color tint for lighting extruded geometries.
Type
color
Default Value
#ffffff
Expression
Parameters: zoom
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}
intensity
Name: intensity
Mapbox spec: intensity
Description
Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.
Type
number
Default Value
0.5
Minimum
0
Maximum
1
Expression
Parameters: zoom
intensityTransition
Name: intensityTransition
Description
The transition affecting any changes to this layer’s intensity property.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}