@rnmapbox/maps 10.0.0-beta.49 → 10.0.0-beta.54

package/docs/GettingStarted.md

@@ -1,87 +0,0 @@
-# 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

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

package/docs/HeatmapLayer.md

@@ -1,215 +0,0 @@
-<!-- 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 property.
-
-### 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 property.
-
-### 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 property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-

package/docs/ImageSource.md

@@ -1,13 +0,0 @@
-<!-- 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.
-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

@@ -1,12 +0,0 @@
-<!-- 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. |
-
-

package/docs/Light.md

@@ -1,159 +0,0 @@
-<!-- This file was autogenerated from Light.js do not modify -->
-# <MapboxGL.Light />
-Light represents the light source for extruded geometries
-
-## props
-| Prop | Type | Default | Required | Description |
-| ---- | :-- | :----- | :------ | :---------- |
-| style | `custom` | `none` | `false` | Customizable style attributes |
-
-
-## styles
-
-* <a href="#anchor">anchor</a><br/>
-* <a href="#position">position</a><br/>
-* <a href="#color">color</a><br/>
-* <a href="#intensity">intensity</a><br/>
-
-___
-
-### anchor
-Name: `anchor`
-
-### Description
-Whether extruded geometries are lit relative to the map or viewport.
-
-### Type
-`enum`
-### Default Value
-`viewport`
-
-### Supported Values
-**map** - The position of the light source is aligned to the rotation of the map.<br />
-**viewport** - The position of the light source is aligned to the rotation of the viewport.<br />
-
-
-### Expression
-
-Parameters: `zoom`
-
-___
-
-### position
-Name: `position`
-
-### Description
-Position of the light source relative to lit (extruded) geometries, in [r radial coordinate, a azimuthal angle, p polar angle] where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0° (0° when `light.anchor` is set to `viewport` corresponds to the top of the viewport, or 0° when `light.anchor` is set to `map` corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0°, directly above, to 180°, directly below).
-
-### Type
-`array<number>`
-### Default Value
-`[1.15,210,30]`
-
-
-### Expression
-
-Parameters: `zoom`
-___
-
-### Name
-
-`positionTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s position property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### color
-Name: `color`
-
-### Description
-Color tint for lighting extruded geometries.
-
-### Type
-`color`
-### Default Value
-`#ffffff`
-
-
-### Expression
-
-Parameters: `zoom`
-___
-
-### Name
-
-`colorTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s color property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### intensity
-Name: `intensity`
-
-### Description
-Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.
-
-### Type
-`number`
-### Default Value
-`0.5`
-
-### Minimum
-`0`
-
-
-### Maximum
-`1`
-
-### Expression
-
-Parameters: `zoom`
-___
-
-### Name
-
-`intensityTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s intensity property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-