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

package/docs/CircleLayer.md

@@ -1,463 +1,487 @@
 <!-- DO NOT MODIFY! -->
 <!-- This file is auto-generated from javascript/components/CircleLayer.tsx -->
-## <MapLibreGL.CircleLayer />
-### CircleLayer is a style layer that renders one or more filled circles on the map.
+# `<MapLibreGL.CircleLayer />`
+CircleLayer is a style layer that renders one or more filled circles on the map.
 
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | style | `CircleLayerStyleProps` | `none` | `false` | Customizable style attributes |
 | sourceID | `FIX ME UNKNOWN TYPE` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | FIX ME NO DESCRIPTION |
 
 
-### styles
+## Styles
 
-* <a href="#name">circleSortKey</a><br/>
-* <a href="#name-1">visibility</a><br/>
-* <a href="#name-2">circleRadius</a><br/>
-* <a href="#name-3">circleColor</a><br/>
-* <a href="#name-4">circleBlur</a><br/>
-* <a href="#name-5">circleOpacity</a><br/>
-* <a href="#name-6">circleTranslate</a><br/>
-* <a href="#name-7">circleTranslateAnchor</a><br/>
-* <a href="#name-8">circlePitchScale</a><br/>
-* <a href="#name-9">circlePitchAlignment</a><br/>
-* <a href="#name-10">circleStrokeWidth</a><br/>
-* <a href="#name-11">circleStrokeColor</a><br/>
-* <a href="#name-12">circleStrokeOpacity</a><br/>
+* <a href="#name">`circleSortKey`</a><br/>
+* <a href="#name-1">`visibility`</a><br/>
+* <a href="#name-2">`circleRadius`</a><br/>
+* <a href="#name-3">`circleColor`</a><br/>
+* <a href="#name-4">`circleBlur`</a><br/>
+* <a href="#name-5">`circleOpacity`</a><br/>
+* <a href="#name-6">`circleTranslate`</a><br/>
+* <a href="#name-7">`circleTranslateAnchor`</a><br/>
+* <a href="#name-8">`circlePitchScale`</a><br/>
+* <a href="#name-9">`circlePitchAlignment`</a><br/>
+* <a href="#name-10">`circleStrokeWidth`</a><br/>
+* <a href="#name-11">`circleStrokeColor`</a><br/>
+* <a href="#name-12">`circleStrokeOpacity`</a><br/>
 
-___
 
-#### Name
-`circleSortKey`
+### `circleSortKey`
 
-#### Description
 Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
 
-#### Type
-`number`
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>number</code>
+    </dd>
+        </ul>
+    </dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom, feature</code></dd>
+</dl>
 
 
-#### Expression
 
-Parameters: `zoom, feature`
+### `visibility`
 
-___
-
-#### Name
-`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 />
-
+<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>
+
+
+
+### `circleRadius`
 
-
-___
-
-#### Name
-`circleRadius`
-
-#### Description
 Circle radius.
 
-#### Type
-`number`
-#### Default Value
-`5`
-
-#### Units
-`pixels`
-
-#### Minimum
-`0`
-
-
-#### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-#### Name
-
-`circleRadiusTransition`
-
-#### Description
-
-The transition affecting any changes to this layer’s circleRadius propery.
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>number</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>5</code></dd>
+        </ul>
+    </dd>
+        <dt>Units</dt>
+        <dd><code>pixels</code></dd>
+        <dt>Minimum</dt>
+        <dd><code>0</code></dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom, feature, feature-state</code></dd>
+</dl>
+
+### `circleRadiusTransition`
+
+The transition affecting any changes to this layer’s circleRadius 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>
+
+
+### `circleColor`
 
-#### Type
-
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-#### Name
-`circleColor`
-
-#### Description
 The fill color of the circle.
 
-#### Type
-`color`
-#### Default Value
-`#000000`
-
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>color</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>#000000</code></dd>
+        </ul>
+    </dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom, feature, feature-state</code></dd>
+</dl>
 
-#### Expression
+### `circleColorTransition`
 
-Parameters: `zoom, feature, feature-state`
-___
+The transition affecting any changes to this layer’s circleColor property.
 
-#### Name
+<dl>
+  <dt>Type</dt>
+  <dd>
+    <code>{ duration, delay }</code>
+  </dd>
 
-`circleColorTransition`
+  <dt>Units</dt>
+  <dd>
+    <code>milliseconds</code>
+  </dd>
 
-#### Description
+  <dt>Default Value</dt>
+  <dd>
+    <code>{duration: 300, delay: 0}</code>
+  </dd>
+</dl>
 
-The transition affecting any changes to this layer’s circleColor propery.
 
-#### Type
+### `circleBlur`
 
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-#### Name
-`circleBlur`
-
-#### Description
 Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
 
-#### Type
-`number`
-#### Default Value
-`0`
-
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>number</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>0</code></dd>
+        </ul>
+    </dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom, feature, feature-state</code></dd>
+</dl>
 
-#### Expression
+### `circleBlurTransition`
 
-Parameters: `zoom, feature, feature-state`
-___
+The transition affecting any changes to this layer’s circleBlur property.
 
-#### Name
+<dl>
+  <dt>Type</dt>
+  <dd>
+    <code>{ duration, delay }</code>
+  </dd>
 
-`circleBlurTransition`
+  <dt>Units</dt>
+  <dd>
+    <code>milliseconds</code>
+  </dd>
 
-#### Description
+  <dt>Default Value</dt>
+  <dd>
+    <code>{duration: 300, delay: 0}</code>
+  </dd>
+</dl>
 
-The transition affecting any changes to this layer’s circleBlur propery.
 
-#### Type
+### `circleOpacity`
 
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-#### Name
-`circleOpacity`
-
-#### Description
 The opacity at which the circle will be drawn.
 
-#### Type
-`number`
-#### Default Value
-`1`
-
-#### Minimum
-`0`
-
-
-#### Maximum
-`1`
-
-#### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-#### Name
-
-`circleOpacityTransition`
-
-#### Description
-
-The transition affecting any changes to this layer’s circleOpacity propery.
-
-#### Type
+<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, feature, feature-state</code></dd>
+</dl>
+
+### `circleOpacityTransition`
+
+The transition affecting any changes to this layer’s circleOpacity 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>
+
+
+### `circleTranslate`
 
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-#### Name
-`circleTranslate`
-
-#### Description
 The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
 
-#### Type
-`array<number>`
-#### Default Value
-`[0,0]`
-
-#### Units
-`pixels`
-
-
-#### Expression
-
-Parameters: `zoom`
-___
-
-#### Name
-
-`circleTranslateTransition`
-
-#### Description
-
-The transition affecting any changes to this layer’s circleTranslate propery.
-
-#### Type
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>array<number></code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>[0,0]</code></dd>
+        </ul>
+    </dd>
+        <dt>Units</dt>
+        <dd><code>pixels</code></dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom</code></dd>
+</dl>
+
+### `circleTranslateTransition`
+
+The transition affecting any changes to this layer’s circleTranslate 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>
+
+
+### `circleTranslateAnchor`
 
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-#### Name
-`circleTranslateAnchor`
-
-#### Description
 Controls the frame of reference for `circleTranslate`.
 
-#### Type
-`enum`
-#### Default Value
-`map`
-
-#### Supported Values
-**map** - The circle is translated relative to the map.<br />
-**viewport** - The circle is translated relative to the viewport.<br />
-
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>enum</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>map</code></dd>
+    <dt>Supported Values</dt>
+    <dd>
+        <ul>
+                <li>
+                    <code>map</code>: The circle is translated relative to the map.
+                </li>
+                <li>
+                    <code>viewport</code>: The circle is translated relative to the viewport.
+                </li>
+        </ul>
+    </dd>
+        <dt>Requires</dt>
+        <dd><code>circleTranslate</code></dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom</code></dd>
+</dl>
+
+
+
+### `circlePitchScale`
 
-#### Requires
-`circleTranslate`
-
-#### Expression
-
-Parameters: `zoom`
-
-___
-
-#### Name
-`circlePitchScale`
-
-#### Description
 Controls the scaling behavior of the circle when the map is pitched.
 
-#### Type
-`enum`
-#### Default Value
-`map`
-
-#### Supported Values
-**map** - Circles are scaled according to their apparent distance to the camera.<br />
-**viewport** - Circles are not scaled.<br />
-
-
-#### Expression
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>enum</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>map</code></dd>
+    <dt>Supported Values</dt>
+    <dd>
+        <ul>
+                <li>
+                    <code>map</code>: Circles are scaled according to their apparent distance to the camera.
+                </li>
+                <li>
+                    <code>viewport</code>: Circles are not scaled.
+                </li>
+        </ul>
+    </dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom</code></dd>
+</dl>
+
+
+
+### `circlePitchAlignment`
 
-Parameters: `zoom`
-
-___
-
-#### Name
-`circlePitchAlignment`
-
-#### Description
 Orientation of circle when map is pitched.
 
-#### Type
-`enum`
-#### Default Value
-`viewport`
-
-#### Supported Values
-**map** - The circle is aligned to the plane of the map.<br />
-**viewport** - The circle is aligned to the plane of the viewport.<br />
-
-
-#### Expression
-
-Parameters: `zoom`
-
-___
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>enum</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>viewport</code></dd>
+    <dt>Supported Values</dt>
+    <dd>
+        <ul>
+                <li>
+                    <code>map</code>: The circle is aligned to the plane of the map.
+                </li>
+                <li>
+                    <code>viewport</code>: The circle is aligned to the plane of the viewport.
+                </li>
+        </ul>
+    </dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom</code></dd>
+</dl>
+
+
+
+### `circleStrokeWidth`
 
-#### Name
-`circleStrokeWidth`
-
-#### Description
 The width of the circle's stroke. Strokes are placed outside of the `circleRadius`.
 
-#### Type
-`number`
-#### Default Value
-`0`
-
-#### Units
-`pixels`
-
-#### Minimum
-`0`
-
-
-#### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-#### Name
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>number</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>0</code></dd>
+        </ul>
+    </dd>
+        <dt>Units</dt>
+        <dd><code>pixels</code></dd>
+        <dt>Minimum</dt>
+        <dd><code>0</code></dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom, feature, feature-state</code></dd>
+</dl>
+
+### `circleStrokeWidthTransition`
+
+The transition affecting any changes to this layer’s circleStrokeWidth 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>
+
+
+### `circleStrokeColor`
 
-`circleStrokeWidthTransition`
-
-#### Description
-
-The transition affecting any changes to this layer’s circleStrokeWidth propery.
-
-#### Type
-
-`{ duration, delay }`
-
-#### Units
-`milliseconds`
-
-#### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-#### Name
-`circleStrokeColor`
-
-#### Description
 The stroke color of the circle.
 
-#### Type
-`color`
-#### Default Value
-`#000000`
-
-
-#### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-#### Name
-
-`circleStrokeColorTransition`
-
-#### Description
+<dl>
+    <dt>Type</dt>
+    <dd>
+        <code>color</code>
+    </dd>
+        <dt>Default Value</dt>
+        <dd><code>#000000</code></dd>
+        </ul>
+    </dd>
+        <dt>Expression Parameters</dt>
+        <dd><code>zoom, feature, feature-state</code></dd>
+</dl>
 
-The transition affecting any changes to this layer’s circleStrokeColor propery.
+### `circleStrokeColorTransition`
 
-#### Type
+The transition affecting any changes to this layer’s circleStrokeColor property.
 
-`{ duration, delay }`
+<dl>
+  <dt>Type</dt>
+  <dd>
+    <code>{ duration, delay }</code>
+  </dd>
 
-#### Units
-`milliseconds`
+  <dt>Units</dt>
+  <dd>
+    <code>milliseconds</code>
+  </dd>
 
-#### Default Value
-`{duration: 300, delay: 0}`
+  <dt>Default Value</dt>
+  <dd>
+    <code>{duration: 300, delay: 0}</code>
+  </dd>
+</dl>
 
 
-___
+### `circleStrokeOpacity`
 
-#### Name
-`circleStrokeOpacity`
-
-#### Description
 The opacity of the circle's stroke.
 
-#### Type
-`number`
-#### Default Value
-`1`
-
-#### Minimum
-`0`
-
-
-#### Maximum
-`1`
-
-#### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-#### Name
-
-`circleStrokeOpacityTransition`
-
-#### Description
-
-The transition affecting any changes to this layer’s circleStrokeOpacity 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, feature, feature-state</code></dd>
+</dl>
+
+### `circleStrokeOpacityTransition`
+
+The transition affecting any changes to this layer’s circleStrokeOpacity 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>