@maplibre/maplibre-react-native 10.0.0-alpha.9 → 10.0.0-beta.2

package/docs/MapView.md

@@ -1,203 +0,0 @@
-<!-- This file was autogenerated from MapView.js do not modify -->
-## <MapLibreGL.MapView />
-### MapView backed by MapLibre GL Native
-
-### 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. |
-| style | `ViewProps["style"]` | `none` | `false` | Style for wrapping React Native View |
-| styleURL | `string` | `none` | `false` | Style URL for map - notice, if non is set it _will_ default to `MapLibreGL.StyleURL.Default` |
-| styleJSON | `string` | `none` | `false` | StyleJSON for map - according to TileJSON specs: https://github.com/mapbox/tilejson-spec |
-| preferredFramesPerSecond | `number` | `none` | `false` | iOS: The preferred frame rate at which the map view is rendered.<br/>The default value for this property is MLNMapViewPreferredFramesPerSecondDefault,<br/>which will adaptively set the preferred frame rate based on the capability of<br/>the user’s device to maintain a smooth experience. This property can be set to arbitrary integer values.<br/><br/>Android: The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.<br/>This property can be set to arbitrary integer values. |
-| localizeLabels | `boolean` | `false` | `false` | Automatically change the language of the map labels to the system’s preferred language,<br/>this is not something that can be toggled on/off |
-| zoomEnabled | `boolean` | `none` | `false` | Enable/Disable zoom on the map |
-| scrollEnabled | `boolean` | `true` | `false` | Enable/Disable scroll on the map |
-| pitchEnabled | `boolean` | `true` | `false` | Enable/Disable pitch on map |
-| rotateEnabled | `boolean` | `true` | `false` | Enable/Disable rotation on map |
-| attributionEnabled | `boolean` | `true` | `false` | Enable/Disable attribution on map.<br/><br/>This must be enabled for Mapbox-hosted tiles and styles. Please refer to the Mapbox Terms of Service.<br/>Other providers do not require this. |
-| attributionPosition | `\| { top?: number; left?: number }
-\| { top?: number; right?: number }
-\| { bottom?: number; left?: number }
-\| { bottom?: number; right?: number }` | `none` | `false` | Adds attribution offset, e.g. `{top: 8, left: 8}` will put attribution button in top-left corner of the map |
-| tintColor | `string \| unknown[]` | `none` | `false` | MapView's tintColor |
-| logoEnabled | `boolean` | `false` | `false` | Enable/Disable the logo on the map. |
-| logoPosition | `\| { top?: number; left?: number }
-\| { top?: number; right?: number }
-\| { bottom?: number; left?: number }
-\| { bottom?: number; right?: number }` | `none` | `false` | Adds logo offset, e.g. `{top: 8, left: 8}` will put the logo in top-left corner of the map |
-| compassEnabled | `boolean` | `none` | `false` | Enable/Disable the compass from appearing on the map |
-| compassViewPosition | `number` | `none` | `false` | Change corner of map the compass starts at. 0: TopLeft, 1: TopRight, 2: BottomLeft, 3: BottomRight |
-| compassViewMargins | `object` | `none` | `false` | Add margins to the compass with x and y values |
-| surfaceView | `boolean` | `false` | `false` | [Android only] Enable/Disable use of GLSurfaceView insted of TextureView. |
-| onUserLocationUpdate | `func` | `none` | `false` | This event is triggered when the user location is updated.<br/>*signature:*`(location:Location) => void` |
-| regionWillChangeDebounceTime | `number` | `10` | `false` | The emitted frequency of regionwillchange events |
-| regionDidChangeDebounceTime | `number` | `500` | `false` | The emitted frequency of regiondidchange events |
-| children | `ReactNode` | `none` | `true` | FIX ME NO DESCRIPTION |
-
-### methods
-#### getPointInView(coordinate)
-
-Converts a geographic coordinate to a point in the given view’s coordinate system.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `coordinate` | `GeoJSON.Position` | `Yes` | A point expressed in the map view's coordinate system. |
-
-
-
-```javascript
-const pointInView = await this._map.getPointInView([-37.817070, 144.949901]);
-```
-
-
-#### getCoordinateFromView(point)
-
-Converts a point in the given view’s coordinate system to a geographic coordinate.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `point` | `Array` | `Yes` | A point expressed in the given view’s coordinate system. |
-
-
-
-```javascript
-const coordinate = await this._map.getCoordinateFromView([100, 100]);
-```
-
-
-#### getVisibleBounds()
-
-The coordinate bounds(ne, sw) visible in the users’s viewport.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-const visibleBounds = await this._map.getVisibleBounds();
-```
-
-
-#### queryRenderedFeaturesAtPoint(point[, filter][, layerIDs])
-
-Returns an array of rendered map features that intersect with a given point.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `point` | `tuple` | `Yes` | undefined |
-| `filter` | `FilterExpression` | `No` | A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array. |
-| `layerIDs` | `Array` | `No` | A array of layer id's to filter the features by |
-
-
-
-```javascript
-this._map.queryRenderedFeaturesAtPoint([30, 40], ['==', 'type', 'Point'], ['id1', 'id2'])
-```
-
-
-#### 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
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `bbox` | `GeoJSON.BBox` | `Yes` | A rectangle expressed in the map view’s coordinate system. |
-| `filter` | `FilterExpression` | `No` | A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array. |
-| `layerIDs` | `Array` | `No` |  A array of layer id's to filter the features by |
-
-
-
-```javascript
-this._map.queryRenderedFeaturesInRect([30, 40, 20, 10], ['==', 'type', 'Point'], ['id1', 'id2'])
-```
-
-
-#### setCamera()
-
-Map camera will perform updates based on provided config. Deprecated use Camera#setCamera.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-#### takeSnap([writeToDisk])
-
-Takes snapshot of map with current tiles and returns a URI to the image
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `writeToDisk` | `Boolean` | `No` | If true will create a temp file, otherwise it is in base64 |
-
-
-#### getZoom()
-
-Returns the current zoom of the map view.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-const zoom = await this._map.getZoom();
-```
-
-
-#### getCenter()
-
-Returns the map's geographical centerpoint
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-const center = await this._map.getCenter();
-```
-
-
-#### setSourceVisibility(visible, sourceId[, sourceLayerId])
-
-Sets the visibility of all the layers referencing the specified `sourceLayerId` and/or `sourceId`
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `visible` | `boolean` | `Yes` | Visibility of the layers |
-| `sourceId` | `string` | `Yes` | Identifier of the target source (e.g. 'composite') |
-| `sourceLayerId` | `String` | `No` | Identifier of the target source-layer (e.g. 'building') |
-
-
-
-```javascript
-await this._map.setSourceVisibility(false, 'composite', 'building')
-```
-
-
-#### 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,16 +0,0 @@
-<!-- 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.
-
-### 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. |
-| anchor | `shape` | `{ x: 0.5, y: 0.5 }` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
-| &nbsp;&nbsp;x | `number` | `none` | `true` | `x` of anchor |
-| &nbsp;&nbsp;y | `number` | `none` | `true` | `y` of anchor |
-| allowOverlap | `boolean` | `false` | `false` | FIX ME NO DESCRIPTION |
-| isSelected | `boolean` | `false` | `false` | FIX ME NO DESCRIPTION |
-| children | `ReactReactElement` | `none` | `true` | Expects one child - can be container with multiple elements |
-
-

package/docs/NativeUserLocation.md

@@ -1,11 +0,0 @@
-<!-- This file was autogenerated from NativeUserLocation.js do not modify -->
-## <MapLibreGL.NativeUserLocation />
-### 
-
-### 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 |
-| iosShowsUserHeadingIndicator | `boolean` | `none` | `false` | iOS only. A Boolean value indicating whether the user location annotation may display a permanent heading indicator.<br/><br/>@platform ios |
-
-

package/docs/OfflineManager.md

@@ -1,246 +0,0 @@
-<!-- This file was autogenerated from offlineManager.js do not modify -->
-## <MapLibreGL.offlineManager />
-### OfflineManager implements a singleton (shared object) that manages offline packs.<br/>All of this class’s instance methods are asynchronous, reflecting the fact that offline resources are stored in a database.<br/>The shared object maintains a canonical collection of offline packs.
-
-
-### methods
-#### createPack(options[, progressListener][, errorListener])
-
-Creates and registers an offline pack that downloads the resources needed to use the given region offline.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `options` | `OfflineCreatePackOptions` | `Yes` | Create options for a offline pack that specifices zoom levels, style url, and the region to download. |
-| `progressListener` | `Callback` | `No` | Callback that listens for status events while downloading the offline resource. |
-| `errorListener` | `Callback` | `No` | Callback that listens for status events while downloading the offline resource. |
-
-
-
-```javascript
-const progressListener = (offlineRegion, status) => console.log(offlineRegion, status);
-const errorListener = (offlineRegion, err) => console.log(offlineRegion, err);
-
-await MapLibreGL.offlineManager.createPack({
-  name: 'offlinePack',
-  styleURL: 'mapbox://...',
-  minZoom: 14,
-  maxZoom: 20,
-  bounds: [[neLng, neLat], [swLng, swLat]]
-}, progressListener, errorListener)
-```
-
-
-#### invalidatePack(name)
-
-Invalidates the specified offline pack. This method checks that the tiles in the specified offline pack match those from the server. Local tiles that do not match the latest version on the server are updated.This is more efficient than deleting the offline pack and downloading it again. If the data stored locally matches that on the server, new data will not be downloaded.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `name` | `String` | `Yes` | Name of the offline pack. |
-
-
-
-```javascript
-await MapLibreGL.offlineManager.invalidatePack('packName')
-```
-
-
-#### deletePack(name)
-
-Unregisters the given offline pack and allows resources that are no longer required by any remaining packs to be potentially freed.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `name` | `String` | `Yes` | Name of the offline pack. |
-
-
-
-```javascript
-await MapLibreGL.offlineManager.deletePack('packName')
-```
-
-
-#### invalidateAmbientCache()
-
-Forces a revalidation of the tiles in the ambient cache and downloads a fresh version of the tiles from the tile server.<br/>This is the recommend method for clearing the cache.<br/>This is the most efficient method because tiles in the ambient cache are re-downloaded to remove outdated data from a device.<br/>It does not erase resources from the ambient cache or delete the database, which can be computationally expensive operations that may carry unintended side effects.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-await MapLibreGL.offlineManager.invalidateAmbientCache();
-```
-
-
-#### clearAmbientCache()
-
-Erases resources from the ambient cache.<br/>This method clears the cache and decreases the amount of space that map resources take up on the device.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-await MapLibreGL.offlineManager.clearAmbientCache();
-```
-
-
-#### setMaximumAmbientCacheSize(size)
-
-Sets the maximum size of the ambient cache in bytes. Disables the ambient cache if set to 0.<br/>This method may be computationally expensive because it will erase resources from the ambient cache if its size is decreased.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `size` | `Number` | `Yes` | Size of ambient cache. |
-
-
-
-```javascript
-await MapLibreGL.offlineManager.setMaximumAmbientCacheSize(5000000);
-```
-
-
-#### resetDatabase()
-
-Deletes the existing database, which includes both the ambient cache and offline packs, then reinitializes it.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-await MapLibreGL.offlineManager.resetDatabase();
-```
-
-
-#### getPacks()
-
-Retrieves all the current offline packs that are stored in the database.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-const offlinePacks = await MapLibreGL.offlineManager.getPacks();
-```
-
-
-#### getPack(name)
-
-Retrieves an offline pack that is stored in the database by name.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `name` | `String` | `Yes` | Name of the offline pack. |
-
-
-
-```javascript
-const offlinePack = await MapLibreGL.offlineManager.getPack();
-```
-
-
-#### mergeOfflineRegions(path)
-
-Sideloads offline db
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `path` | `String` | `Yes` | Path to offline tile db on file system. |
-
-
-
-```javascript
-await MapLibreGL.offlineManager.mergeOfflineRegions(path);
-```
-
-
-#### setTileCountLimit(limit)
-
-Sets the maximum number of tiles that may be downloaded and stored on the current device.<br/>Consult the Terms of Service for your map tile host before changing this value.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `limit` | `Number` | `Yes` | Map tile limit count. |
-
-
-
-```javascript
-MapLibreGL.offlineManager.setTileCountLimit(1000);
-```
-
-
-#### setProgressEventThrottle(throttleValue)
-
-Sets the period at which download status events will be sent over the React Native bridge.<br/>The default is 500ms.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `throttleValue` | `Number` | `Yes` | event throttle value in ms. |
-
-
-
-```javascript
-MapLibreGL.offlineManager.setProgressEventThrottle(500);
-```
-
-
-#### subscribe(packName, progressListener, errorListener)
-
-Subscribe to download status/error events for the requested offline pack.<br/>Note that createPack calls this internally if listeners are provided.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `packName` | `String` | `Yes` | Name of the offline pack. |
-| `progressListener` | `Callback` | `Yes` | Callback that listens for status events while downloading the offline resource. |
-| `errorListener` | `Callback` | `Yes` | Callback that listens for status events while downloading the offline resource. |
-
-
-
-```javascript
-const progressListener = (offlinePack, status) => console.log(offlinePack, status)
-const errorListener = (offlinePack, err) => console.log(offlinePack, err)
-MapLibreGL.offlineManager.subscribe('packName', progressListener, errorListener)
-```
-
-
-#### unsubscribe(packName)
-
-Unsubscribes any listeners associated with the offline pack.<br/>It's a good idea to call this on componentWillUnmount.
-
-##### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `packName` | `String` | `Yes` | Name of the offline pack. |
-
-
-
-```javascript
-MapLibreGL.offlineManager.unsubscribe('packName')
-```
-
-
-

package/docs/PointAnnotation.md

@@ -1,31 +0,0 @@
-<!-- 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.
-
-### props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| id | `string` | `none` | `true` | A string that uniquely identifies the annotation |
-| title | `string` | `none` | `false` | The string containing the annotation’s title. Note this is required to be set if you want to see a callout appear on iOS. |
-| snippet | `string` | `none` | `false` | The string containing the annotation’s snippet(subtitle). Not displayed in the default callout. |
-| selected | `boolean` | `none` | `false` | Manually selects/deselects annotation<br/>@type {[type]} |
-| draggable | `boolean` | `false` | `false` | Enable or disable dragging. Defaults to false. |
-| coordinate | `Array` | `none` | `true` | The center point (specified as a map coordinate) of the annotation. |
-| anchor | `shape` | `{ x: 0.5, y: 0.5 }` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
-| &nbsp;&nbsp;x | `number` | `none` | `true` | See anchor |
-| &nbsp;&nbsp;y | `number` | `none` | `true` | See anchor |
-| 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()
-
-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  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-