Light
A style's light
property provides a global light source for that style. Since this property is the light used to light extruded features, you will only see visible changes to your map style when modifying this property if you are using extrusions.
"light": {
"anchor": "viewport",
"color": "white",
"intensity": 0.4
}
anchor
Optional enum. One of "map"
, "viewport"
. Defaults to "viewport"
.
Whether extruded geometries are lit relative to the map or viewport.
"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.
"anchor": "map"
SDK Support | Goong GL JS | Android SDK | iOS SDK | macOS SDK |
---|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 | >= 0.5.0 |
color
Optional color. Defaults to "#ffffff"
. Supports interpolate
expressions. Transitionable.
Color tint for lighting extruded geometries.
SDK Support | Goong GL JS | Android SDK | iOS SDK | macOS SDK |
---|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 | >= 0.5.0 |
intensity
Optional number between 0
and 1
inclusive. Defaults to 0.5. Supports interpolate
expressions. Transitionable.
Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.
SDK Support | Goong GL JS | Android SDK | iOS SDK | macOS SDK |
---|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 | >= 0.5.0 |
position
Optional array of numbers. Defaults to [1.15,210,30]. Supports interpolate
expressions. Transitionable.
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).
"position": [
1.5,
90,
80
]
SDK Support | Goong GL JS | Android SDK | iOS SDK | macOS SDK |
---|---|---|---|---|
basic functionality | >= 0.27.0 | >= 5.1.0 | >= 3.6.0 | >= 0.5.0 |