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

package/docs/MapView.md

@@ -1,8 +1,9 @@
-<!-- This file was autogenerated from MapView.js do not modify -->
-## <MapLibreGL.MapView />
-### MapView backed by MapLibre Native
+<!-- DO NOT MODIFY! -->
+<!-- This file is auto-generated from javascript/components/MapView.tsx -->
+# `<MapLibreGL.MapView />`
+MapView backed by MapLibre Native
 
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | contentInset | `number[] \| number` | `none` | `false` | The distance from the edges of the map view’s frame to the edges of the map view’s logical viewport. |
@@ -29,12 +30,12 @@
 | regionDidChangeDebounceTime | `number` | `500` | `false` | The emitted frequency of regiondidchange events |
 | children | `ReactNode` | `none` | `true` | FIX ME NO DESCRIPTION |
 
-### methods
-#### getPointInView(coordinate)
+## Methods
+### `getPointInView(coordinate)`
 
 Converts a geographic coordinate to a point in the given view’s coordinate system.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `coordinate` | `GeoJSON.Position` | `Yes` | A point expressed in the map view's coordinate system. |
@@ -46,11 +47,11 @@ const pointInView = await this._map.getPointInView([-37.817070, 144.949901]);
 ```
 
 
-#### getCoordinateFromView(point)
+### `getCoordinateFromView(point)`
 
 Converts a point in the given view’s coordinate system to a geographic coordinate.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `point` | `Array` | `Yes` | A point expressed in the given view’s coordinate system. |
@@ -62,14 +63,10 @@ const coordinate = await this._map.getCoordinateFromView([100, 100]);
 ```
 
 
-#### getVisibleBounds()
+### `getVisibleBounds()`
 
 The coordinate bounds(ne, sw) visible in the users’s viewport.
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
 
@@ -78,11 +75,11 @@ const visibleBounds = await this._map.getVisibleBounds();
 ```
 
 
-#### queryRenderedFeaturesAtPoint(point[, filter][, layerIDs])
+### `queryRenderedFeaturesAtPoint(point, [filter], [layerIDs])`
 
 Returns an array of rendered map features that intersect with a given point.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `point` | `tuple` | `Yes` | undefined |
@@ -96,11 +93,11 @@ this._map.queryRenderedFeaturesAtPoint([30, 40], ['==', 'type', 'Point'], ['id1'
 ```
 
 
-#### queryRenderedFeaturesInRect(bbox[, filter][, layerIDs])
+### `queryRenderedFeaturesInRect(bbox, [filter], [layerIDs])`
 
 Returns an array of rendered map features that intersect with the given rectangle,<br/>restricted to the given style layers and filtered by the given predicate.
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `bbox` | `GeoJSON.BBox` | `Yes` | A rectangle expressed in the map view’s coordinate system. |
@@ -114,34 +111,26 @@ this._map.queryRenderedFeaturesInRect([30, 40, 20, 10], ['==', 'type', 'Point'],
 ```
 
 
-#### setCamera()
+### `setCamera()`
 
 Map camera will perform updates based on provided config. Deprecated use Camera#setCamera.
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
-#### takeSnap([writeToDisk])
+### `takeSnap([writeToDisk])`
 
 Takes snapshot of map with current tiles and returns a URI to the image
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `writeToDisk` | `Boolean` | `No` | If true will create a temp file, otherwise it is in base64 |
 
 
-#### getZoom()
+### `getZoom()`
 
 Returns the current zoom of the map view.
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
 
@@ -150,14 +139,10 @@ const zoom = await this._map.getZoom();
 ```
 
 
-#### getCenter()
+### `getCenter()`
 
 Returns the map's geographical centerpoint
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
 
@@ -166,11 +151,11 @@ const center = await this._map.getCenter();
 ```
 
 
-#### setSourceVisibility(visible, sourceId[, sourceLayerId])
+### `setSourceVisibility(visible, sourceId, [sourceLayerId])`
 
 Sets the visibility of all the layers referencing the specified `sourceLayerId` and/or `sourceId`
 
-##### arguments
+#### Arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
 | `visible` | `boolean` | `Yes` | Visibility of the layers |
@@ -184,14 +169,10 @@ await this._map.setSourceVisibility(false, 'composite', 'building')
 ```
 
 
-#### showAttribution()
+### `showAttribution()`
 
 Show the attribution and telemetry action sheet.<br/>If you implement a custom attribution button, you should add this action to the button.
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
 
 
 

package/docs/MarkerView.md

@@ -1,8 +1,9 @@
-<!-- This file was autogenerated from MarkerView.js do not modify -->
-## <MapLibreGL.MarkerView />
-### 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.
+<!-- DO NOT MODIFY! -->
+<!-- This file is auto-generated from javascript/components/MarkerView.tsx -->
+# `<MapLibreGL.MarkerView />`
+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.
 
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | coordinate | `Array` | `none` | `true` | The center point (specified as a map coordinate) of the marker.<br/>See also #anchor. |

package/docs/NativeUserLocation.md

@@ -1,8 +1,9 @@
-<!-- This file was autogenerated from NativeUserLocation.js do not modify -->
-## <MapLibreGL.NativeUserLocation />
-### 
+<!-- DO NOT MODIFY! -->
+<!-- This file is auto-generated from javascript/components/NativeUserLocation.tsx -->
+# `<MapLibreGL.NativeUserLocation />`
 
-### props
+
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | androidRenderMode | `"normal" \| "compass" \| "gps"` | `none` | `false` | Android render mode.<br/><br/> - normal: just a circle<br/> - compass: triangle with heading<br/> - gps: large arrow<br/><br/>@platform android |

package/docs/PointAnnotation.md

@@ -1,8 +1,9 @@
-<!-- This file was autogenerated from PointAnnotation.js do not modify -->
-## <MapLibreGL.PointAnnotation />
-### PointAnnotation represents a one-dimensional shape located at a single geographical coordinate.<br/><br/>Consider using ShapeSource and SymbolLayer instead, if you have many points and you have static images,<br/>they'll offer much better performance<br/><br/>.<br/>If you need interctive views please use MarkerView,<br/>as with PointAnnotation on Android child views are rendered onto a bitmap for better performance.
+<!-- DO NOT MODIFY! -->
+<!-- This file is auto-generated from javascript/components/PointAnnotation.tsx -->
+# `<MapLibreGL.PointAnnotation />`
+PointAnnotation represents a one-dimensional shape located at a single geographical coordinate.<br/><br/>Consider using ShapeSource and SymbolLayer instead, if you have many points and you have static images,<br/>they'll offer much better performance<br/><br/>.<br/>If you need interctive views please use MarkerView,<br/>as with PointAnnotation on Android child views are rendered onto a bitmap for better performance.
 
-### props
+## Props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | id | `string` | `none` | `true` | A string that uniquely identifies the annotation |
@@ -17,15 +18,11 @@
 | children | `React.ReactElement \| [React.ReactElement, React.ReactElement]` | `none` | `true` | Expects one child, and an optional callout can be added as well |
 | style | `ViewProps["style"]` | `none` | `false` | FIX ME NO DESCRIPTION |
 
-### methods
-#### refresh()
+## Methods
+### `refresh()`
 
 On android point annotation is rendered offscreen with a canvas into an image.<br/>To rerender the image from the current state of the view call refresh.<br/>Call this for example from Image#onLoad.
 
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-