@maplibre/maplibre-react-native 8.6.0-beta.0

package/docs/RasterLayer.md

@@ -0,0 +1,357 @@
+<!-- This file was autogenerated from RasterLayer.js do not modify -->
+## <MapboxGL.RasterLayer />
+### 
+
+### props
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. |
+| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | The source from which to obtain the data to style.<br/>If the source has not yet been added to the current style, the behavior is undefined.<br/>Inferred from parent source only if the layer is a direct child to it. |
+| sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
+| aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. |
+| belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID |
+| layerIndex | `number` | `none` | `false` | Inserts a layer at a specified index |
+| filter | `array` | `none` | `false` | Filter only the features in the source layer that satisfy a condition that you define |
+| minZoomLevel | `number` | `none` | `false` | The minimum zoom level at which the layer gets parsed and appears. |
+| maxZoomLevel | `number` | `none` | `false` | The maximum zoom level at which the layer gets parsed and appears. |
+| style | `union` | `none` | `false` | Customizable style attributes |
+
+
+### styles
+
+* <a href="#name">visibility</a><br/>
+* <a href="#name-1">rasterOpacity</a><br/>
+* <a href="#name-2">rasterHueRotate</a><br/>
+* <a href="#name-3">rasterBrightnessMin</a><br/>
+* <a href="#name-4">rasterBrightnessMax</a><br/>
+* <a href="#name-5">rasterSaturation</a><br/>
+* <a href="#name-6">rasterContrast</a><br/>
+* <a href="#name-7">rasterResampling</a><br/>
+* <a href="#name-8">rasterFadeDuration</a><br/>
+
+___
+
+#### 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 />
+
+
+
+___
+
+#### Name
+`rasterOpacity`
+
+#### Description
+The opacity at which the image will be drawn.
+
+#### Type
+`number`
+#### Default Value
+`1`
+
+#### Minimum
+`0`
+
+
+#### Maximum
+`1`
+
+#### Expression
+
+Parameters: `zoom`
+___
+
+#### Name
+
+`rasterOpacityTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s rasterOpacity propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`rasterHueRotate`
+
+#### Description
+Rotates hues around the color wheel.
+
+#### Type
+`number`
+#### Default Value
+`0`
+
+#### Units
+`degrees`
+
+
+#### Expression
+
+Parameters: `zoom`
+___
+
+#### Name
+
+`rasterHueRotateTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s rasterHueRotate propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`rasterBrightnessMin`
+
+#### Description
+Increase or reduce the brightness of the image. The value is the minimum brightness.
+
+#### Type
+`number`
+#### Default Value
+`0`
+
+#### Minimum
+`0`
+
+
+#### Maximum
+`1`
+
+#### Expression
+
+Parameters: `zoom`
+___
+
+#### Name
+
+`rasterBrightnessMinTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s rasterBrightnessMin propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`rasterBrightnessMax`
+
+#### Description
+Increase or reduce the brightness of the image. The value is the maximum brightness.
+
+#### Type
+`number`
+#### Default Value
+`1`
+
+#### Minimum
+`0`
+
+
+#### Maximum
+`1`
+
+#### Expression
+
+Parameters: `zoom`
+___
+
+#### Name
+
+`rasterBrightnessMaxTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s rasterBrightnessMax propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`rasterSaturation`
+
+#### Description
+Increase or reduce the saturation of the image.
+
+#### Type
+`number`
+#### Default Value
+`0`
+
+#### Minimum
+`-1`
+
+
+#### Maximum
+`1`
+
+#### Expression
+
+Parameters: `zoom`
+___
+
+#### Name
+
+`rasterSaturationTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s rasterSaturation propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`rasterContrast`
+
+#### Description
+Increase or reduce the contrast of the image.
+
+#### Type
+`number`
+#### Default Value
+`0`
+
+#### Minimum
+`-1`
+
+
+#### Maximum
+`1`
+
+#### Expression
+
+Parameters: `zoom`
+___
+
+#### Name
+
+`rasterContrastTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s rasterContrast propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### Name
+`rasterResampling`
+
+#### Description
+The resampling/interpolation method to use for overscaling, also known as texture magnification filter
+
+#### Type
+`enum`
+#### Default Value
+`linear`
+
+#### Supported Values
+**linear** - (Bi)linear filtering interpolates pixel values using the weighted average of the four closest original source pixels creating a smooth but blurry look when overscaled<br />
+**nearest** - Nearest neighbor filtering interpolates pixel values using the nearest original source pixel creating a sharp but pixelated look when overscaled<br />
+
+
+#### Expression
+
+Parameters: `zoom`
+
+___
+
+#### Name
+`rasterFadeDuration`
+
+#### Description
+Fade duration when a new tile is added.
+
+#### Type
+`number`
+#### Default Value
+`300`
+
+#### Units
+`milliseconds`
+
+#### Minimum
+`0`
+
+
+#### Expression
+
+Parameters: `zoom`
+

package/docs/RasterSource.md

@@ -0,0 +1,17 @@
+<!-- This file was autogenerated from RasterSource.js do not modify -->
+## <MapboxGL.RasterSource />
+### RasterSource is a map content source that supplies raster image tiles to be shown on the map.<br/>The location of and metadata about the tiles are defined either by an option dictionary<br/>or by an external file that conforms to the TileJSON specification.
+
+### props
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| id | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | A string that uniquely identifies the source. |
+| url | `string` | `none` | `false` | A URL to a TileJSON configuration file describing the source’s contents and other metadata. |
+| tileUrlTemplates | `array` | `none` | `false` | An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints.<br/>Example: https://example.com/raster-tiles/{z}/{x}/{y}.png |
+| minZoomLevel | `number` | `none` | `false` | An unsigned integer that specifies the minimum zoom level at which to display tiles from the source.<br/>The value should be between 0 and 22, inclusive, and less than<br/>maxZoomLevel, if specified. The default value for this option is 0. |
+| maxZoomLevel | `number` | `none` | `false` | An unsigned integer that specifies the maximum zoom level at which to display tiles from the source.<br/>The value should be between 0 and 22, inclusive, and less than<br/>minZoomLevel, if specified. The default value for this option is 22. |
+| tileSize | `number` | `none` | `false` | Size of the map tiles.<br/>Mapbox urls default to 256, all others default to 512. |
+| tms | `bool` | `none` | `false` | Influences the y direction of the tile coordinates. (tms inverts y axis) |
+| attribution | `string` | `none` | `false` | An HTML or literal text string defining the buttons to be displayed in an action sheet when the<br/>source is part of a map view’s style and the map view’s attribution button is pressed. |
+
+

package/docs/ShapeSource.md

@@ -0,0 +1,100 @@
+<!-- This file was autogenerated from ShapeSource.js do not modify -->
+## <MapboxGL.ShapeSource />
+### ShapeSource is a map content source that supplies vector shapes to be shown on the map.<br/>The shape may be a url or a GeoJSON object
+
+### props
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| id | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | A string that uniquely identifies the source. |
+| url | `string` | `none` | `false` | An HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle. |
+| shape | `object` | `none` | `false` | The contents of the source. A shape can represent a GeoJSON geometry, a feature, or a feature colllection. |
+| cluster | `bool` | `none` | `false` | Enables clustering on the source for point shapes. |
+| clusterRadius | `number` | `none` | `false` | Specifies the radius of each cluster if clustering is enabled.<br/>A value of 512 produces a radius equal to the width of a tile.<br/>The default value is 50. |
+| clusterMaxZoomLevel | `number` | `none` | `false` | Specifies the maximum zoom level at which to cluster points if clustering is enabled.<br/>Defaults to one zoom level less than the value of maxZoomLevel so that, at the maximum zoom level,<br/>the shapes are not clustered. |
+| maxZoomLevel | `number` | `none` | `false` | Specifies the maximum zoom level at which to create vector tiles.<br/>A greater value produces greater detail at high zoom levels.<br/>The default value is 18. |
+| buffer | `number` | `none` | `false` | Specifies the size of the tile buffer on each side.<br/>A value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself.<br/>Larger values produce fewer rendering artifacts near tile edges and slower performance.<br/>The default value is 128. |
+| tolerance | `number` | `none` | `false` | Specifies the Douglas-Peucker simplification tolerance.<br/>A greater value produces simpler geometries and improves performance.<br/>The default value is 0.375. |
+| lineMetrics | `bool` | `none` | `false` | Whether to calculate line distance metrics.<br/>This is required for line layers that specify lineGradient values.<br/>The default value is false. |
+| onPress | `func` | `none` | `false` | Source press listener, gets called when a user presses one of the children layers only<br/>if that layer has a higher z-index than another source layers |
+| hitbox | `shape` | `none` | `false` | Overrides the default touch hitbox(44x44 pixels) for the source layers |
+| &nbsp;&nbsp;width | `number` | `none` | `true` | `width` of hitbox |
+| &nbsp;&nbsp;height | `number` | `none` | `true` | `height` of hitbox |
+
+### methods
+#### features([filter])
+
+Returns all features from the source that match the query parameters regardless of whether or not the feature is<br/>currently rendered on the map.
+
+##### arguments
+| Name | Type | Required | Description  |
+| ---- | :--: | :------: | :----------: |
+| `filter` | `Array` | `No` | an optional filter statement to filter the returned Features. |
+
+
+
+```javascript
+shapeSource.features()
+```
+
+
+#### getClusterExpansionZoom(feature)
+
+Returns the zoom needed to expand the cluster.
+
+##### arguments
+| Name | Type | Required | Description  |
+| ---- | :--: | :------: | :----------: |
+| `feature` | `Feature` | `Yes` | The feature cluster to expand. |
+
+
+
+```javascript
+const zoom = await shapeSource.getClusterExpansionZoom(clusterId);
+```
+
+
+#### getClusterLeaves(feature, limit, offset)
+
+Returns the FeatureCollection from the cluster.
+
+##### arguments
+| Name | Type | Required | Description  |
+| ---- | :--: | :------: | :----------: |
+| `feature` | `Feature` | `Yes` | The feature cluster to expand. |
+| `limit` | `number` | `Yes` | The number of points to return. |
+| `offset` | `number` | `Yes` | The amount of points to skip (for pagination). |
+
+
+
+```javascript
+const collection = await shapeSource.getClusterLeaves(clusterId, limit, offset);
+```
+
+
+#### getClusterChildren(feature)
+
+Returns the FeatureCollection from the cluster (on the next zoom level).
+
+##### arguments
+| Name | Type | Required | Description  |
+| ---- | :--: | :------: | :----------: |
+| `feature` | `Feature` | `Yes` | The feature cluster to expand. |
+
+
+
+```javascript
+const collection = await shapeSource.getClusterChildren(clusterId);
+```
+
+
+#### onPress(event)
+
+
+
+##### arguments
+| Name | Type | Required | Description  |
+| ---- | :--: | :------: | :----------: |
+| `event` | `n/a` | `Yes` | undefined |
+
+
+

package/docs/Style.md

@@ -0,0 +1,10 @@
+<!-- This file was autogenerated from Style.js do not modify -->
+## <MapboxGL.Style />
+### Style is a component that automatically adds sources / layers to the map using Mapbox GL Style Spec.<br/>Only [`sources`](https://docs.mapbox.com/mapbox-gl-js/style-spec/sources) & [`layers`](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/) are supported.<br/>Other fields such as `sprites`, `glyphs` etc. will be ignored. Not all layer / source attributes from the style spec are supported, in general the supported attributes will be mentioned under https://github.com/maplibre/maplibre-react-native/tree/main/docs.<br/><br/>TODO: Maintainer forking this project does not understand the above comment regarding what is supported.
+
+### props
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| json | `any` | `none` | `false` | A JSON object conforming to the schema described in the Mapbox Style Specification , or a URL to such JSON. |
+
+