@maplibre/maplibre-react-native 10.0.0-alpha.25 → 10.0.0-alpha.26

package/docs/HeatmapLayer.md

@@ -1,208 +1,214 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/components/HeatmapLayer.tsx -->
-## <MapLibreGL.HeatmapLayer />
-### HeatmapLayer is a style layer that renders one or more filled circles on the map.
+# `<MapLibreGL.HeatmapLayer />`
+HeatmapLayer is a style layer that renders one or more filled circles on the map.
 
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | style | `HeatmapLayerStyleProps` | `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">heatmapRadius</a><br/>
-* <a href="#name-2">heatmapWeight</a><br/>
-* <a href="#name-3">heatmapIntensity</a><br/>
-* <a href="#name-4">heatmapColor</a><br/>
-* <a href="#name-5">heatmapOpacity</a><br/>
+* <a href="#name">`visibility`</a><br/>
+* <a href="#name-1">`heatmapRadius`</a><br/>
+* <a href="#name-2">`heatmapWeight`</a><br/>
+* <a href="#name-3">`heatmapIntensity`</a><br/>
+* <a href="#name-4">`heatmapColor`</a><br/>
+* <a href="#name-5">`heatmapOpacity`</a><br/>
 
-___
 
-#### Name
-`visibility`
+### `visibility`
 
-#### Description
 Whether this layer is displayed.
 
-#### Type
-`enum`
-#### Default Value
-`visible`
+<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>
+
+
+
+### `heatmapRadius`
 
-#### Supported Values
-**visible** - The layer is shown.<br />
-**none** - The layer is not shown.<br />
-
-
-
-___
-
-#### Name
-`heatmapRadius`
-
-#### Description
 Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.
 
-#### Type
-`number`
-#### Default Value
-`30`
-
-#### Units
-`pixels`
-
-#### Minimum
-`1`
-
-
-#### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-#### Name
-
-`heatmapRadiusTransition`
-
-#### Description
-
-The transition affecting any changes to this layer’s heatmapRadius propery.
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>number</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>30</code></dd>
+        </ul>
+    </dd>
+        <dt>Units</dt>
+        <dd><code>pixels</code></dd>
+        <dt>Minimum</dt>
+        <dd><code>1</code></dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom, feature, feature-state</code></dd>
+</dl>
+
+### `heatmapRadiusTransition`
+
+The transition affecting any changes to this layer’s heatmapRadius 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>
+
+
+### `heatmapWeight`
 
-#### Type
-
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-#### Name
-`heatmapWeight`
-
-#### Description
 A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
 
-#### Type
-`number`
-#### Default Value
-`1`
+<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>Expression Parameters</dt>
+        <dd><code>zoom, feature, feature-state</code></dd>
+</dl>
 
-#### Minimum
-`0`
 
 
-#### Expression
+### `heatmapIntensity`
 
-Parameters: `zoom, feature, feature-state`
-
-___
-
-#### Name
-`heatmapIntensity`
-
-#### Description
 Similar to `heatmapWeight` but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
 
-#### Type
-`number`
-#### Default Value
-`1`
-
-#### Minimum
-`0`
-
-
-#### Expression
-
-Parameters: `zoom`
-___
+<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>Expression Parameters</dt>
+        <dd><code>zoom</code></dd>
+</dl>
+
+### `heatmapIntensityTransition`
+
+The transition affecting any changes to this layer’s heatmapIntensity 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>
+
+
+### `heatmapColor`
 
-#### Name
-
-`heatmapIntensityTransition`
-
-#### Description
-
-The transition affecting any changes to this layer’s heatmapIntensity propery.
-
-#### Type
-
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-#### Name
-`heatmapColor`
-
-#### Description
 Defines the color of each pixel based on its density value in a heatmap.  Should be an expression that uses `["heatmapDensity"]` as input.
 
-#### Type
-`color`
-#### Default Value
-`interpolate,linear,heatmap-density,0,rgba(0, 0, 255, 0),0.1,royalblue,0.3,cyan,0.5,lime,0.7,yellow,1,red`
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>color</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>interpolate,linear,heatmap-density,0,rgba(0, 0, 255, 0),0.1,royalblue,0.3,cyan,0.5,lime,0.7,yellow,1,red</code></dd>
+        </ul>
+    </dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>heatmap-density</code></dd>
+</dl>
 
 
-#### Expression
 
-Parameters: `heatmap-density`
+### `heatmapOpacity`
 
-___
-
-#### Name
-`heatmapOpacity`
-
-#### Description
 The global opacity at which the heatmap layer will be drawn.
 
-#### Type
-`number`
-#### Default Value
-`1`
-
-#### Minimum
-`0`
-
-
-#### Maximum
-`1`
-
-#### Expression
-
-Parameters: `zoom`
-___
-
-#### Name
-
-`heatmapOpacityTransition`
-
-#### Description
-
-The transition affecting any changes to this layer’s heatmapOpacity 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>
+
+### `heatmapOpacityTransition`
+
+The transition affecting any changes to this layer’s heatmapOpacity 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>
 

package/docs/ImageSource.md

@@ -1,9 +1,9 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/components/ImageSource.tsx -->
-## <MapLibreGL.ImageSource />
-### ImageSource is a content source that is used for a georeferenced raster image to be shown on the map.<br/>The georeferenced image scales and rotates as the user zooms and rotates the map
+# `<MapLibreGL.ImageSource />`
+ImageSource is a content source that is used for a georeferenced raster image to be shown on the map.<br/>The georeferenced image scales and rotates as the user zooms and rotates the map
 
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | id | `string` | `none` | `true` | A string that uniquely identifies the source. |

package/docs/Images.md

@@ -1,9 +1,9 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/components/Images.tsx -->
-## <MapLibreGL.Images />
-### Images defines the images used in Symbol etc layers
+# `<MapLibreGL.Images />`
+Images defines the images used in Symbol etc layers
 
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | images | `shape` | `none` | `false` | Specifies the external images in key-value pairs required for the shape source.<br/>Keys are names - see iconImage expressions, values can be either urls-s objects<br/>with format {uri: 'http://...'}` or `require('image.png')` or `import 'image.png'` |