-
-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: omit empty arguments * docs: improve section headlines * docs: method signatures as code * docs: restructure styles * docs: styles toc and remove lines * docs: codegen * docs: style params as definition lists * docs: add code to component headlines
- Loading branch information
1 parent
0e0de9a
commit 885e67e
Showing
30 changed files
with
3,972 additions
and
3,820 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,159 +1,166 @@ | ||
| <!-- DO NOT MODIFY! --> | ||
| <!-- This file is auto-generated from javascript/components/BackgroundLayer.tsx --> | ||
| ## <MapLibreGL.BackgroundLayer /> | ||
| ### | ||
| # `<MapLibreGL.BackgroundLayer />` | ||
|
|
||
| ### props | ||
|
|
||
| ## Props | ||
| | Prop | Type | Default | Required | Description | | ||
| | ---- | :--: | :-----: | :------: | :----------: | | ||
| | style | `BackgroundLayerStyleProps` | `none` | `false` | Customizable style attributes | | ||
| | sourceID | `FIX ME UNKNOWN TYPE` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | FIX ME NO DESCRIPTION | | ||
|
|
||
|
|
||
| ### styles | ||
| ## Styles | ||
|
|
||
| * <a href="#name">visibility</a><br/> | ||
| * <a href="#name-1">backgroundColor</a><br/> | ||
| * <a href="#name-2">backgroundPattern</a><br/> | ||
| * <a href="#name-3">backgroundOpacity</a><br/> | ||
| * <a href="#name">`visibility`</a><br/> | ||
| * <a href="#name-1">`backgroundColor`</a><br/> | ||
| * <a href="#name-2">`backgroundPattern`</a><br/> | ||
| * <a href="#name-3">`backgroundOpacity`</a><br/> | ||
|
|
||
| ___ | ||
|
|
||
| #### Name | ||
| `visibility` | ||
| ### `visibility` | ||
|
|
||
| #### Description | ||
| Whether this layer is displayed. | ||
|
|
||
| #### Type | ||
| `enum` | ||
| #### Default Value | ||
| `visible` | ||
|
|
||
| #### Supported Values | ||
| **visible** - The layer is shown.<br /> | ||
| **none** - The layer is not shown.<br /> | ||
|
|
||
|
|
||
|
|
||
| ___ | ||
|
|
||
| #### Name | ||
| `backgroundColor` | ||
| <dl> | ||
| <dt>Type</dt> | ||
| <dd> | ||
| <code>enum</code> | ||
| </dd> | ||
| <dt>Default Value</dt> | ||
| <dd><code>visible</code></dd> | ||
| <dt>Supported Values</dt> | ||
| <dd> | ||
| <ul> | ||
| <li> | ||
| <code>visible</code>: The layer is shown. | ||
| </li> | ||
| <li> | ||
| <code>none</code>: The layer is not shown. | ||
| </li> | ||
| </ul> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
| ### `backgroundColor` | ||
|
|
||
| #### Description | ||
| The color with which the background will be drawn. | ||
|
|
||
| #### Type | ||
| `color` | ||
| #### Default Value | ||
| `#000000` | ||
|
|
||
|
|
||
| #### Disabled By | ||
| `backgroundPattern` | ||
|
|
||
| #### Expression | ||
|
|
||
| Parameters: `zoom` | ||
| ___ | ||
|
|
||
| #### Name | ||
|
|
||
| `backgroundColorTransition` | ||
|
|
||
| #### Description | ||
|
|
||
| The transition affecting any changes to this layer’s backgroundColor propery. | ||
|
|
||
| #### Type | ||
|
|
||
| `{ duration, delay }` | ||
|
|
||
| #### Units | ||
| `milliseconds` | ||
|
|
||
| #### Default Value | ||
| `{duration: 300, delay: 0}` | ||
|
|
||
|
|
||
| ___ | ||
|
|
||
| #### Name | ||
| `backgroundPattern` | ||
| <dl> | ||
| <dt>Type</dt> | ||
| <dd> | ||
| <code>color</code> | ||
| </dd> | ||
| <dt>Default Value</dt> | ||
| <dd><code>#000000</code></dd> | ||
| </ul> | ||
| </dd> | ||
| <dt>Disabled By</dt> | ||
| <dd><code>backgroundPattern</code></dd> | ||
| <dt>Expression Parameters</dt> | ||
| <dd><code>zoom</code></dd> | ||
| </dl> | ||
|
|
||
| ### `backgroundColorTransition` | ||
|
|
||
| The transition affecting any changes to this layer’s backgroundColor property. | ||
|
|
||
| <dl> | ||
| <dt>Type</dt> | ||
| <dd> | ||
| <code>{ duration, delay }</code> | ||
| </dd> | ||
|
|
||
| <dt>Units</dt> | ||
| <dd> | ||
| <code>milliseconds</code> | ||
| </dd> | ||
|
|
||
| <dt>Default Value</dt> | ||
| <dd> | ||
| <code>{duration: 300, delay: 0}</code> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
| ### `backgroundPattern` | ||
|
|
||
| #### Description | ||
| 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). Note that zoomDependent expressions will be evaluated only at integer zoom levels. | ||
|
|
||
| #### Type | ||
| `resolvedImage` | ||
| <dl> | ||
| <dt>Type</dt> | ||
| <dd> | ||
| <code>resolvedImage</code> | ||
| </dd> | ||
| </ul> | ||
| </dd> | ||
| <dt>Expression Parameters</dt> | ||
| <dd><code>zoom</code></dd> | ||
| </dl> | ||
|
|
||
| ### `backgroundPatternTransition` | ||
|
|
||
| #### Expression | ||
| The transition affecting any changes to this layer’s backgroundPattern property. | ||
|
|
||
| Parameters: `zoom` | ||
| ___ | ||
| <dl> | ||
| <dt>Type</dt> | ||
| <dd> | ||
| <code>{ duration, delay }</code> | ||
| </dd> | ||
|
|
||
| #### Name | ||
| <dt>Units</dt> | ||
| <dd> | ||
| <code>milliseconds</code> | ||
| </dd> | ||
|
|
||
| `backgroundPatternTransition` | ||
| <dt>Default Value</dt> | ||
| <dd> | ||
| <code>{duration: 300, delay: 0}</code> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| #### Description | ||
|
|
||
| The transition affecting any changes to this layer’s backgroundPattern propery. | ||
| ### `backgroundOpacity` | ||
|
|
||
| #### Type | ||
|
|
||
| `{ duration, delay }` | ||
|
|
||
| #### Units | ||
| `milliseconds` | ||
|
|
||
| #### Default Value | ||
| `{duration: 300, delay: 0}` | ||
|
|
||
|
|
||
| ___ | ||
|
|
||
| #### Name | ||
| `backgroundOpacity` | ||
|
|
||
| #### Description | ||
| The opacity at which the background will be drawn. | ||
|
|
||
| #### Type | ||
| `number` | ||
| #### Default Value | ||
| `1` | ||
|
|
||
| #### Minimum | ||
| `0` | ||
|
|
||
|
|
||
| #### Maximum | ||
| `1` | ||
|
|
||
| #### Expression | ||
|
|
||
| Parameters: `zoom` | ||
| ___ | ||
|
|
||
| #### Name | ||
|
|
||
| `backgroundOpacityTransition` | ||
|
|
||
| #### Description | ||
|
|
||
| The transition affecting any changes to this layer’s backgroundOpacity propery. | ||
|
|
||
| #### Type | ||
|
|
||
| `{ duration, delay }` | ||
|
|
||
| #### Units | ||
| `milliseconds` | ||
|
|
||
| #### Default Value | ||
| `{duration: 300, delay: 0}` | ||
|
|
||
| <dl> | ||
| <dt>Type</dt> | ||
| <dd> | ||
| <code>number</code> | ||
| </dd> | ||
| <dt>Default Value</dt> | ||
| <dd><code>1</code></dd> | ||
| </ul> | ||
| </dd> | ||
| <dt>Minimum</dt> | ||
| <dd><code>0</code></dd> | ||
| <dt>Maximum</dt> | ||
| <dd><code>1</code></dd> | ||
| <dt>Expression Parameters</dt> | ||
| <dd><code>zoom</code></dd> | ||
| </dl> | ||
|
|
||
| ### `backgroundOpacityTransition` | ||
|
|
||
| The transition affecting any changes to this layer’s backgroundOpacity property. | ||
|
|
||
| <dl> | ||
| <dt>Type</dt> | ||
| <dd> | ||
| <code>{ duration, delay }</code> | ||
| </dd> | ||
|
|
||
| <dt>Units</dt> | ||
| <dd> | ||
| <code>milliseconds</code> | ||
| </dd> | ||
|
|
||
| <dt>Default Value</dt> | ||
| <dd> | ||
| <code>{duration: 300, delay: 0}</code> | ||
| </dd> | ||
| </dl> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.