@rnmapbox/maps 10.0.0-beta.28

package/docs/FillLayer.md

@@ -0,0 +1,310 @@
+<!-- This file was autogenerated from FillLayer.js do not modify -->
+## <MapboxGL.FillLayer />
+### FillLayer is a style layer that renders one or more filled (and optionally stroked) polygons on the map.
+
+### 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="#fillsortkey">fillSortKey</a><br/>
+* <a href="#visibility">visibility</a><br/>
+* <a href="#fillantialias">fillAntialias</a><br/>
+* <a href="#fillopacity">fillOpacity</a><br/>
+* <a href="#fillcolor">fillColor</a><br/>
+* <a href="#filloutlinecolor">fillOutlineColor</a><br/>
+* <a href="#filltranslate">fillTranslate</a><br/>
+* <a href="#filltranslateanchor">fillTranslateAnchor</a><br/>
+* <a href="#fillpattern">fillPattern</a><br/>
+
+___
+
+#### fillSortKey
+Name: `fillSortKey`
+
+#### 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`
+
+
+#### 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 />
+
+
+
+___
+
+#### fillAntialias
+Name: `fillAntialias`
+
+#### Description
+Whether or not the fill should be antialiased.
+
+#### Type
+`boolean`
+#### Default Value
+`true`
+
+
+#### Expression
+
+Parameters: `zoom`
+
+___
+
+#### fillOpacity
+Name: `fillOpacity`
+
+#### Description
+The opacity of the entire fill layer. In contrast to the `fillColor`, this value will also affect the 1px stroke around the fill, if the stroke is used.
+
+#### Type
+`number`
+#### Default Value
+`1`
+
+#### Minimum
+`0`
+
+
+#### Maximum
+`1`
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+___
+
+#### Name
+
+`fillOpacityTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillOpacity propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### fillColor
+Name: `fillColor`
+
+#### Description
+The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
+
+#### Type
+`color`
+#### Default Value
+`#000000`
+
+
+#### Disabled By
+`fillPattern`
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+___
+
+#### Name
+
+`fillColorTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillColor propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### fillOutlineColor
+Name: `fillOutlineColor`
+
+#### Description
+The outline color of the fill. Matches the value of `fillColor` if unspecified.
+
+#### Type
+`color`
+
+
+#### Disabled By
+`fillPattern`
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+___
+
+#### Name
+
+`fillOutlineColorTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillOutlineColor propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### fillTranslate
+Name: `fillTranslate`
+
+#### 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
+
+`fillTranslateTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillTranslate propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### fillTranslateAnchor
+Name: `fillTranslateAnchor`
+
+#### Description
+Controls the frame of reference for `fillTranslate`.
+
+#### Type
+`enum`
+#### Default Value
+`map`
+
+#### Supported Values
+**map** - The fill is translated relative to the map.<br />
+**viewport** - The fill is translated relative to the viewport.<br />
+
+
+#### Requires
+`fillTranslate`
+
+#### Expression
+
+Parameters: `zoom`
+
+___
+
+#### fillPattern
+Name: `fillPattern`
+
+#### Description
+Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoomDependent expressions will be evaluated only at integer zoom levels.
+
+#### Type
+`resolvedImage`
+
+
+#### Expression
+
+Parameters: `zoom, feature`
+___
+
+#### Name
+
+`fillPatternTransition`
+
+#### Description
+
+The transition affecting any changes to this layer’s fillPattern propery.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+

package/docs/GettingStarted.md

@@ -0,0 +1,87 @@
+# Getting Started
+
+Congratulations, you successfully installed rnmapbox/maps! 🎉
+Where to go from here?
+You can head straight to [examples](/example) folder if you want to jump into the deep end.
+However, if you prefer an easier ramp-up, then make sure to stick around and check out the guides below.
+
+## Setting your accessToken
+
+In order to work, mapbox requires you to create an accessToken and set it in your app.
+If you haven't created one yet, make sure to sign up for an account [here](https://www.mapbox.com/signup/)
+You can create and manage your access tokens on your [Mapbox Account page](https://www.mapbox.com/account/)
+Once you have your accessToken, set it like this
+
+```js
+import MapboxGL from "@rnmapbox/maps";
+
+MapboxGL.setAccessToken("<YOUR_ACCESSTOKEN>");
+```
+
+## Setting connection status [Android only]
+
+If you are hosting styles and sources on localhost, you might need to set the connection status manually for Mapbox to be able to use them. See [mapbox/mapbox-gl-native#12819](https://github.com/mapbox/mapbox-gl-native/issues/12819).
+
+Manually sets the connectivity state of the app, bypassing any checks to the ConnectivityManager. Set to `true` for connected, `false` for disconnected, and `null` for ConnectivityManager to determine.
+
+```js
+import MapboxGL from "@rnmapbox/maps";
+
+MapboxGL.setConnected(true);
+```
+
+## Disabling Telemetry
+
+By default mapbox collects telemetry.
+If you would like to programmatically disable this within your app add the code below.
+
+```js
+  componentDidMount() {
+    MapboxGL.setTelemetryEnabled(false);
+  }
+```
+
+For more information on mapbox and telemetry: [https://www.mapbox.com/telemetry](https://www.mapbox.com/telemetry)
+
+## Show a map
+
+```js
+import React, { Component } from "react";
+import { StyleSheet, View } from "react-native";
+import MapboxGL from "@rnmapbox/maps";
+
+MapboxGL.setAccessToken("<YOUR_ACCESSTOKEN>");
+
+const styles = StyleSheet.create({
+  page: {
+    flex: 1,
+    justifyContent: "center",
+    alignItems: "center",
+    backgroundColor: "#F5FCFF"
+  },
+  container: {
+    height: 300,
+    width: 300,
+    backgroundColor: "tomato"
+  },
+  map: {
+    flex: 1
+  }
+});
+
+export default class App extends Component {
+  componentDidMount() {
+    MapboxGL.setTelemetryEnabled(false);
+  }
+
+  render() {
+    return (
+      <View style={styles.page}>
+        <View style={styles.container}>
+          <MapboxGL.MapView style={styles.map} />
+        </View>
+      </View>
+    );
+  }
+}
+```

package/docs/HeadingIndicator.md

@@ -0,0 +1,10 @@
+<!-- This file was autogenerated from HeadingIndicator.js do not modify -->
+## <MapboxGL.HeadingIndicator />
+### 
+
+### props
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| heading | `number` | `none` | `false` | FIX ME NO DESCRIPTION |
+
+

package/docs/HeatmapLayer.md

@@ -0,0 +1,215 @@
+<!-- This file was autogenerated from HeatmapLayer.js do not modify -->
+## <MapboxGL.HeatmapLayer />
+### HeatmapLayer is a style layer that renders one or more filled circles on the map.
+
+### 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<br/>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="#visibility">visibility</a><br/>
+* <a href="#heatmapradius">heatmapRadius</a><br/>
+* <a href="#heatmapweight">heatmapWeight</a><br/>
+* <a href="#heatmapintensity">heatmapIntensity</a><br/>
+* <a href="#heatmapcolor">heatmapColor</a><br/>
+* <a href="#heatmapopacity">heatmapOpacity</a><br/>
+
+___
+
+#### 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 />
+
+
+
+___
+
+#### heatmapRadius
+Name: `heatmapRadius`
+
+#### Description
+Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed. `queryRenderedFeatures` on heatmap layers will return points within this radius.
+
+#### 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.
+
+#### Type
+
+`{ duration, delay }`
+
+#### Units
+`milliseconds`
+
+#### Default Value
+`{duration: 300, delay: 0}`
+
+
+___
+
+#### heatmapWeight
+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`
+
+#### Minimum
+`0`
+
+
+#### Expression
+
+Parameters: `zoom, feature, feature-state`
+
+___
+
+#### heatmapIntensity
+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`
+___
+
+#### 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}`
+
+
+___
+
+#### heatmapColor
+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`
+
+
+#### 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}`
+
+

package/docs/ImageSource.md

@@ -0,0 +1,12 @@
+<!-- This file was autogenerated from ImageSource.js do not modify -->
+## <MapboxGL.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
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| id | `string` | `none` | `true` | A string that uniquely identifies the source. |
+| url | `union` | `none` | `false` | An HTTP(S) URL, absolute file URL, or local file URL to the source image.<br/>Gifs are currently not supported. |
+| coordinates | `array` | `none` | `true` | The top left, top right, bottom right, and bottom left coordinates for the image. |
+
+

package/docs/Images.md

@@ -0,0 +1,12 @@
+<!-- This file was autogenerated from Images.js do not modify -->
+## <MapboxGL.Images />
+### Images defines the images used in Symbol etc layers
+
+### props
+| Prop | Type | Default | Required | Description |
+| ---- | :--: | :-----: | :------: | :----------: |
+| images | `object` | `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'` |
+| nativeAssetImages | `array` | `none` | `false` | If you have an asset under Image.xcassets on iOS and the drawables directory on android<br/>you can specify an array of string names with assets as the key `['pin']`. |
+| onImageMissing | `func` | `none` | `false` | Gets called when a Layer is trying to render an image whose key is not present in<br/>any of the `Images` component of the Map. |
+
+