Skip to content

Commit cc586b3

Browse files
author
Nick
committed
Updated docs
1 parent 5a94ab2 commit cc586b3

File tree

5 files changed

+429
-0
lines changed

5 files changed

+429
-0
lines changed

docs/BackgroundLayer.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## <MapboxGL.BackgroundLayer />
2+
###
3+
4+
### props
5+
| Prop | Type | Default | Required | Description |
6+
| ---- | :--: | :-----: | :------: | :----------: |
7+
| id | `string` | `none` | `false` | A string that uniquely identifies the source in the style to which it is added. |
8+
| 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+
| 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. |
10+
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
11+
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |
12+
| layerIndex | `number` | `none` | `false` | Inserts a layer at a specified index |
13+
| filter | `array` | `none` | `false` | Filter only the features in the source layer that satisfy a condition that you define |
14+
| minZoomLevel | `number` | `none` | `false` | The minimum zoom level at which the layer gets parsed and appears. |
15+
| maxZoomLevel | `number` | `none` | `false` | The maximum zoom level at which the layer gets parsed and appears. |
16+
| style | `custom` | `none` | `false` | Customizable style attributes |
17+
18+
19+
### styles
20+
| Name | Type | Requires | Disabled By | Description |
21+
| ---- | :--: | :------: | :---------: | :----------: |
22+
| `visibility` | `enum` | `none` | `none` | Whether this layer is displayed. |
23+
| `backgroundColor` | `color` | `none` | `background-pattern` | The color with which the background will be drawn. |
24+
| `backgroundPattern` | `string` | `none` | `none` | Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). |
25+
| `backgroundOpacity` | `number` | `none` | `none` | The opacity at which the background will be drawn. |

docs/Light.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## <MapboxGL.Light />
2+
### Light represents the light source for extruded geometries
3+
4+
### props
5+
| Prop | Type | Default | Required | Description |
6+
| ---- | :--: | :-----: | :------: | :----------: |
7+
| style | `custom` | `none` | `false` | Customizable style attributes |
8+
9+
10+
### styles
11+
| Name | Type | Requires | Disabled By | Description |
12+
| ---- | :--: | :------: | :---------: | :----------: |
13+
| `anchor` | `enum` | `none` | `none` | Whether extruded geometries are lit relative to the map or viewport. |
14+
| `position` | `array` | `none` | `none` | 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). |
15+
| `color` | `color` | `none` | `none` | Color tint for lighting extruded geometries. |
16+
| `intensity` | `number` | `none` | `none` | Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast. |

docs/RasterLayer.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## <MapboxGL.RasterLayer />
2+
###
3+
4+
### props
5+
| Prop | Type | Default | Required | Description |
6+
| ---- | :--: | :-----: | :------: | :----------: |
7+
| id | `string` | `none` | `false` | A string that uniquely identifies the source in the style to which it is added. |
8+
| 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+
| 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. |
10+
| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
11+
| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |
12+
| layerIndex | `number` | `none` | `false` | Inserts a layer at a specified index |
13+
| filter | `array` | `none` | `false` | Filter only the features in the source layer that satisfy a condition that you define |
14+
| minZoomLevel | `number` | `none` | `false` | The minimum zoom level at which the layer gets parsed and appears. |
15+
| maxZoomLevel | `number` | `none` | `false` | The maximum zoom level at which the layer gets parsed and appears. |
16+
| style | `custom` | `none` | `false` | Customizable style attributes |
17+
18+
19+
### styles
20+
| Name | Type | Requires | Disabled By | Description |
21+
| ---- | :--: | :------: | :---------: | :----------: |
22+
| `visibility` | `enum` | `none` | `none` | Whether this layer is displayed. |
23+
| `rasterOpacity` | `number` | `none` | `none` | The opacity at which the image will be drawn. |
24+
| `rasterHueRotate` | `number` | `none` | `none` | Rotates hues around the color wheel. |
25+
| `rasterBrightnessMin` | `number` | `none` | `none` | Increase or reduce the brightness of the image. The value is the minimum brightness. |
26+
| `rasterBrightnessMax` | `number` | `none` | `none` | Increase or reduce the brightness of the image. The value is the maximum brightness. |
27+
| `rasterSaturation` | `number` | `none` | `none` | Increase or reduce the saturation of the image. |
28+
| `rasterContrast` | `number` | `none` | `none` | Increase or reduce the contrast of the image. |
29+
| `rasterFadeDuration` | `number` | `none` | `none` | Fade duration when a new tile is added. |

docs/RasterSource.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## <MapboxGL.RasterSource />
2+
### RasterSource is a map content source that supplies raster image tiles to be shown on the map.<br/>The location of and metadata about the tiles are defined either by an option dictionary<br/>or by an external file that conforms to the TileJSON specification.
3+
4+
### props
5+
| Prop | Type | Default | Required | Description |
6+
| ---- | :--: | :-----: | :------: | :----------: |
7+
| id | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | A string that uniquely identifies the source. |
8+
| url | `string` | `none` | `false` | A URL to a TileJSON configuration file describing the source’s contents and other metadata. |
9+
| minZoomLevel | `number` | `none` | `false` | An unsigned integer that specifies the minimum zoom level at which to display tiles from the source.<br/>The value should be between 0 and 22, inclusive, and less than<br/>maxZoomLevel, if specified. The default value for this option is 0. |
10+
| maxZoomLevel | `number` | `none` | `false` | An unsigned integer that specifies the maximum zoom level at which to display tiles from the source.<br/>The value should be between 0 and 22, inclusive, and less than<br/>minZoomLevel, if specified. The default value for this option is 22. |
11+
| tileSize | `number` | `none` | `false` | Size of the map tiles.<br/>Mapbox urls default to 256, all others default to 512. |
12+
| tms | `bool` | `none` | `false` | Influences the y direction of the tile coordinates. (tms inverts y axis) |
13+
| attribution | `string` | `none` | `false` | An HTML or literal text string defining the buttons to be displayed in an action sheet when the<br/>source is part of a map view’s style and the map view’s attribution button is pressed. |
14+
15+

0 commit comments

Comments
 (0)