Light
Light represents the light source for extruded geometries¶
Props¶
| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
| style | LightLayerStyleProps |
none |
false |
Customizable style attributes |
Styles¶
Anchor¶
Name
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
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 propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
Color¶
Name
color
Description Color tint for lighting extruded geometries.
Type
color
Default Value
#ffffff
Expression
Parameters: zoom
Name
colorTransition
Description
The transition affecting any changes to this layer’s color propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
Intensity¶
Name
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 propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}