Skip to content

Commit 5a92abd

Browse files
ludvigerikssonmfazekas
authored andcommitted
Clarify when sourceID is inferred in documentation
1 parent 1e95594 commit 5a92abd

18 files changed

+35
-22
lines changed

docs/BackgroundLayer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| Prop | Type | Default | Required | Description |
77
| ---- | :--: | :-----: | :------: | :----------: |
88
| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
9-
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined. |
9+
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
1010
| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
1111
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
1212
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |

docs/CircleLayer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| Prop | Type | Default | Required | Description |
77
| ---- | :--: | :-----: | :------: | :----------: |
88
| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
9-
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined. |
9+
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
1010
| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property<br/>from which the receiver obtains the data to style. |
1111
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
1212
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |

docs/FillExtrusionLayer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| Prop | Type | Default | Required | Description |
77
| ---- | :--: | :-----: | :------: | :----------: |
88
| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
9-
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined. |
9+
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
1010
| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
1111
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
1212
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |

docs/FillLayer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| Prop | Type | Default | Required | Description |
77
| ---- | :--: | :-----: | :------: | :----------: |
88
| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
9-
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined. |
9+
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
1010
| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
1111
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
1212
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |

docs/HeatmapLayer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| Prop | Type | Default | Required | Description |
77
| ---- | :--: | :-----: | :------: | :----------: |
88
| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
9-
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined. |
9+
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
1010
| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property<br/>from which the receiver obtains the data to style. |
1111
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
1212
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |

docs/LineLayer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| Prop | Type | Default | Required | Description |
77
| ---- | :--: | :-----: | :------: | :----------: |
88
| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
9-
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined. |
9+
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
1010
| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
1111
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
1212
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |

docs/MarkerView.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- This file was autogenerated from MarkerView.js do not modify -->
22
## <MapboxGL.MarkerView />
3-
### MarkerView allows you to place an interactive react native marker to the map.<br/><br/>If you have static view, consider using PointAnnotation or SymbolLayer. They'll offer much better performance.<br/><br/>This is based on [MarkerView plugin](https://docs.mapbox.com/android/plugins/overview/markerview/) on Android and PointAnnotation on iOS.
3+
### MarkerView allows you to place a interactive react native marker to the map.<br/><br/>If you have static view consider using PointAnnotation or SymbolLayer they'll offer much better performance<br/>.<br/>This is based on [MakerView plugin](https://docs.mapbox.com/android/plugins/overview/markerview/) on Android<br/>and PointAnnotation on iOS.
44

55
### props
66
| Prop | Type | Default | Required | Description |

docs/RasterLayer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| Prop | Type | Default | Required | Description |
77
| ---- | :--: | :-----: | :------: | :----------: |
88
| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
9-
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined. |
9+
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
1010
| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
1111
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
1212
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |

docs/SymbolLayer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| Prop | Type | Default | Required | Description |
77
| ---- | :--: | :-----: | :------: | :----------: |
88
| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
9-
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined. |
9+
| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
1010
| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
1111
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
1212
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |

docs/docs.json

+8-8
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"required": false,
1717
"type": "string",
1818
"default": "MapboxGL.StyleSource.DefaultSourceID",
19-
"description": "The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined."
19+
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it."
2020
},
2121
{
2222
"name": "sourceLayerID",
@@ -832,7 +832,7 @@
832832
"required": false,
833833
"type": "string",
834834
"default": "MapboxGL.StyleSource.DefaultSourceID",
835-
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined."
835+
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it."
836836
},
837837
{
838838
"name": "sourceLayerID",
@@ -1173,7 +1173,7 @@
11731173
"required": false,
11741174
"type": "string",
11751175
"default": "MapboxGL.StyleSource.DefaultSourceID",
1176-
"description": "The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined."
1176+
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it."
11771177
},
11781178
{
11791179
"name": "sourceLayerID",
@@ -1424,7 +1424,7 @@
14241424
"required": false,
14251425
"type": "string",
14261426
"default": "MapboxGL.StyleSource.DefaultSourceID",
1427-
"description": "The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined."
1427+
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it."
14281428
},
14291429
{
14301430
"name": "sourceLayerID",
@@ -1684,7 +1684,7 @@
16841684
"required": false,
16851685
"type": "string",
16861686
"default": "MapboxGL.StyleSource.DefaultSourceID",
1687-
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined."
1687+
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it."
16881688
},
16891689
{
16901690
"name": "sourceLayerID",
@@ -2083,7 +2083,7 @@
20832083
"required": false,
20842084
"type": "string",
20852085
"default": "MapboxGL.StyleSource.DefaultSourceID",
2086-
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined."
2086+
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it."
20872087
},
20882088
{
20892089
"name": "sourceLayerID",
@@ -3313,7 +3313,7 @@
33133313
"required": false,
33143314
"type": "string",
33153315
"default": "MapboxGL.StyleSource.DefaultSourceID",
3316-
"description": "The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined."
3316+
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it."
33173317
},
33183318
{
33193319
"name": "sourceLayerID",
@@ -3952,7 +3952,7 @@
39523952
"required": false,
39533953
"type": "string",
39543954
"default": "MapboxGL.StyleSource.DefaultSourceID",
3955-
"description": "The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined."
3955+
"description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it."
39563956
},
39573957
{
39583958
"name": "sourceLayerID",

javascript/components/BackgroundLayer.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ class BackgroundLayer extends AbstractLayer {
2121
id: PropTypes.string.isRequired,
2222

2323
/**
24-
* The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined.
24+
* The source from which to obtain the data to style.
25+
* If the source has not yet been added to the current style, the behavior is undefined.
26+
* Inferred from parent source only if the layer is a direct child to it.
2527
*/
2628
sourceID: PropTypes.string,
2729

javascript/components/CircleLayer.js

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ class CircleLayer extends AbstractLayer {
2626
/**
2727
* The source from which to obtain the data to style.
2828
* If the source has not yet been added to the current style, the behavior is undefined.
29+
* Inferred from parent source only if the layer is a direct child to it.
2930
*/
3031
sourceID: PropTypes.string,
3132

javascript/components/FillExtrusionLayer.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ class FillExtrusionLayer extends AbstractLayer {
2424
id: PropTypes.string.isRequired,
2525

2626
/**
27-
* The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined.
27+
* The source from which to obtain the data to style.
28+
* If the source has not yet been added to the current style, the behavior is undefined.
29+
* Inferred from parent source only if the layer is a direct child to it.
2830
*/
2931
sourceID: PropTypes.string,
3032

javascript/components/FillLayer.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ class FillLayer extends AbstractLayer {
2424
id: PropTypes.string.isRequired,
2525

2626
/**
27-
* The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined.
27+
* The source from which to obtain the data to style.
28+
* If the source has not yet been added to the current style, the behavior is undefined.
29+
* Inferred from parent source only if the layer is a direct child to it.
2830
*/
2931
sourceID: PropTypes.string,
3032

javascript/components/HeatmapLayer.js

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ class HeatmapLayer extends AbstractLayer {
2626
/**
2727
* The source from which to obtain the data to style.
2828
* If the source has not yet been added to the current style, the behavior is undefined.
29+
* Inferred from parent source only if the layer is a direct child to it.
2930
*/
3031
sourceID: PropTypes.string,
3132

javascript/components/LineLayer.js

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ class LineLayer extends AbstractLayer {
2626
/**
2727
* The source from which to obtain the data to style.
2828
* If the source has not yet been added to the current style, the behavior is undefined.
29+
* Inferred from parent source only if the layer is a direct child to it.
2930
*/
3031
sourceID: PropTypes.string,
3132

javascript/components/RasterLayer.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ class RasterLayer extends AbstractLayer {
2121
id: PropTypes.string.isRequired,
2222

2323
/**
24-
* The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined.
24+
* The source from which to obtain the data to style.
25+
* If the source has not yet been added to the current style, the behavior is undefined.
26+
* Inferred from parent source only if the layer is a direct child to it.
2527
*/
2628
sourceID: PropTypes.string,
2729

javascript/components/SymbolLayer.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ class SymbolLayer extends AbstractLayer {
2424
id: PropTypes.string.isRequired,
2525

2626
/**
27-
* The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined.
27+
* The source from which to obtain the data to style.
28+
* If the source has not yet been added to the current style, the behavior is undefined.
29+
* Inferred from parent source only if the layer is a direct child to it.
2830
*/
2931
sourceID: PropTypes.string,
3032

0 commit comments

Comments
 (0)