Skip to content

Commit 82a6b22

Browse files
Update docs from maps rnmapbox/maps@e3f43f8
1 parent d8f0c76 commit 82a6b22

File tree

73 files changed

+2795
-7
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+2795
-7
lines changed

docs/components/Atmosphere.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ FIX ME NO DESCRIPTION
4040
* <a href="#spacecolor">spaceColor</a><br/>
4141
* <a href="#horizonblend">horizonBlend</a><br/>
4242
* <a href="#starintensity">starIntensity</a><br/>
43+
* <a href="#verticalrange">verticalRange</a><br/>
4344

4445
___
4546

@@ -293,3 +294,45 @@ The transition affecting any changes to this layer’s starIntensity property.
293294
`{duration: 300, delay: 0}`
294295

295296

297+
___
298+
299+
### verticalRange
300+
Name: `verticalRange`
301+
302+
Mapbox spec: [vertical-range](https://docs.mapbox.com/style-spec/reference/layers/#vertical-range)
303+
304+
#### Description
305+
An array of two number values, specifying the vertical range, measured in meters, over which the fog should gradually fade out. When both parameters are set to zero, the fog will be rendered without any vertical constraints.
306+
307+
#### Type
308+
`array<number>`
309+
#### Default Value
310+
`[0,0]`
311+
312+
#### Minimum
313+
`0`
314+
315+
316+
#### Expression
317+
318+
Parameters: `zoom, measure-light`
319+
___
320+
321+
### verticalRangeTransition
322+
Name: `verticalRangeTransition`
323+
324+
#### Description
325+
326+
The transition affecting any changes to this layer’s verticalRange property.
327+
328+
#### Type
329+
330+
`{ duration, delay }`
331+
332+
#### Units
333+
`milliseconds`
334+
335+
#### Default Value
336+
`{duration: 300, delay: 0}`
337+
338+

docs/components/BackgroundLayer.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,11 @@ Customizable style attributes
128128
## styles
129129

130130
* <a href="#visibility">visibility</a><br/>
131+
* <a href="#backgroundpitchalignment">backgroundPitchAlignment</a><br/>
131132
* <a href="#backgroundcolor">backgroundColor</a><br/>
132133
* <a href="#backgroundpattern">backgroundPattern</a><br/>
133134
* <a href="#backgroundopacity">backgroundOpacity</a><br/>
135+
* <a href="#backgroundemissivestrength">backgroundEmissiveStrength</a><br/>
134136

135137
___
136138

@@ -152,6 +154,30 @@ Whether this layer is displayed.
152154
**none** - The layer is not shown.<br />
153155

154156

157+
#### Expression
158+
159+
Parameters: ``
160+
161+
___
162+
163+
### backgroundPitchAlignment
164+
Name: `backgroundPitchAlignment`
165+
166+
Mapbox spec: [background-pitch-alignment](https://docs.mapbox.com/style-spec/reference/layers/#paint-background-background-pitch-alignment)
167+
168+
#### Description
169+
Orientation of background layer.
170+
171+
#### Type
172+
`enum`
173+
#### Default Value
174+
`map`
175+
176+
#### Supported Values
177+
**map** - The background is aligned to the plane of the map.<br />
178+
**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.<br />
179+
180+
155181
#### Expression
156182

157183
Parameters: ``
@@ -261,3 +287,51 @@ The transition affecting any changes to this layer’s backgroundOpacity propert
261287
`{duration: 300, delay: 0}`
262288

263289

290+
___
291+
292+
### backgroundEmissiveStrength
293+
Name: `backgroundEmissiveStrength`
294+
295+
Mapbox spec: [background-emissive-strength](https://docs.mapbox.com/style-spec/reference/layers/#paint-background-background-emissive-strength)
296+
297+
#### Description
298+
Controls the intensity of light emitted on the source features.
299+
300+
#### Type
301+
`number`
302+
#### Default Value
303+
`0`
304+
305+
#### Units
306+
`intensity`
307+
308+
#### Minimum
309+
`0`
310+
311+
312+
#### Requires
313+
`lights`
314+
315+
#### Expression
316+
317+
Parameters: `zoom, measure-light`
318+
___
319+
320+
### backgroundEmissiveStrengthTransition
321+
Name: `backgroundEmissiveStrengthTransition`
322+
323+
#### Description
324+
325+
The transition affecting any changes to this layer’s backgroundEmissiveStrength property.
326+
327+
#### Type
328+
329+
`{ duration, delay }`
330+
331+
#### Units
332+
`milliseconds`
333+
334+
#### Default Value
335+
`{duration: 300, delay: 0}`
336+
337+

docs/components/CircleLayer.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,7 @@ Customizable style attributes
139139
## styles
140140

141141
* <a href="#circlesortkey">circleSortKey</a><br/>
142+
* <a href="#circleelevationreference">circleElevationReference</a><br/>
142143
* <a href="#visibility">visibility</a><br/>
143144
* <a href="#circleradius">circleRadius</a><br/>
144145
* <a href="#circlecolor">circleColor</a><br/>
@@ -151,6 +152,7 @@ Customizable style attributes
151152
* <a href="#circlestrokewidth">circleStrokeWidth</a><br/>
152153
* <a href="#circlestrokecolor">circleStrokeColor</a><br/>
153154
* <a href="#circlestrokeopacity">circleStrokeOpacity</a><br/>
155+
* <a href="#circleemissivestrength">circleEmissiveStrength</a><br/>
154156

155157
___
156158

@@ -172,6 +174,30 @@ Parameters: `zoom, feature`
172174

173175
___
174176

177+
### circleElevationReference
178+
Name: `circleElevationReference`
179+
180+
Mapbox spec: [circle-elevation-reference](https://docs.mapbox.com/style-spec/reference/layers/#layout-circle-circle-elevation-reference)
181+
182+
#### Description
183+
Selects the base of circleElevation. Some modes might require precomputed elevation data in the tileset.
184+
185+
#### Type
186+
`enum`
187+
#### Default Value
188+
`none`
189+
190+
#### Supported Values
191+
**none** - Elevated rendering is disabled.<br />
192+
**hd-road-markup** - Elevated rendering is enabled. Use this mode to describe additive and stackable features that should exist only on top of road polygons.<br />
193+
194+
195+
#### Expression
196+
197+
Parameters: ``
198+
199+
___
200+
175201
### visibility
176202
Name: `visibility`
177203

@@ -608,3 +634,51 @@ The transition affecting any changes to this layer’s circleStrokeOpacity prope
608634
`{duration: 300, delay: 0}`
609635

610636

637+
___
638+
639+
### circleEmissiveStrength
640+
Name: `circleEmissiveStrength`
641+
642+
Mapbox spec: [circle-emissive-strength](https://docs.mapbox.com/style-spec/reference/layers/#paint-circle-circle-emissive-strength)
643+
644+
#### Description
645+
Controls the intensity of light emitted on the source features.
646+
647+
#### Type
648+
`number`
649+
#### Default Value
650+
`0`
651+
652+
#### Units
653+
`intensity`
654+
655+
#### Minimum
656+
`0`
657+
658+
659+
#### Requires
660+
`lights`
661+
662+
#### Expression
663+
664+
Parameters: `zoom, measure-light`
665+
___
666+
667+
### circleEmissiveStrengthTransition
668+
Name: `circleEmissiveStrengthTransition`
669+
670+
#### Description
671+
672+
The transition affecting any changes to this layer’s circleEmissiveStrength property.
673+
674+
#### Type
675+
676+
`{ duration, delay }`
677+
678+
#### Units
679+
`milliseconds`
680+
681+
#### Default Value
682+
`{duration: 300, delay: 0}`
683+
684+

0 commit comments

Comments
 (0)