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

package/docs/Camera.md

@@ -1,152 +0,0 @@
-<!-- This file was autogenerated from Camera.tsx do not modify -->
-# <MapboxGL.Camera />
-Controls the perspective from which the user sees the map.
-
-To use imperative methods, pass in a ref object:
-
-```tsx
-const camera = useRef<Camera>(null);
-
-useEffect(() => {
-  camera.current?.setCamera({
-    centerCoordinate: [lon, lat],
-  });
-}, []);
-
-return (
-  <Camera ref={camera} />
-);
-```
-
-## props
-| Prop | Type | Default | Required | Description |
-| ---- | :-- | :----- | :------ | :---------- |
-| type | `literal` | `none` | `false` | Allows static check of the data type. For internal use only. |
-| centerCoordinate | `Position` | `none` | `false` | The location on which the map should center. |
-| bounds | `intersection` | `none` | `false` | The corners of a box around which the map should bound. Contains padding props for backwards<br/>compatibility; the root `padding` prop should be used instead. |
-| heading | `number` | `none` | `false` | The heading (orientation) of the map. |
-| pitch | `number` | `none` | `false` | The pitch of the map. |
-| zoomLevel | `number` | `none` | `false` | The zoom level of the map. |
-| padding | `shape` | `none` | `false` | The viewport padding in points. |
-| &nbsp;&nbsp;paddingLeft | `number` | `none` | `true` | Left padding in points |
-| &nbsp;&nbsp;paddingRight | `number` | `none` | `true` | Right padding in points |
-| &nbsp;&nbsp;paddingTop | `number` | `none` | `true` | Top padding in points |
-| &nbsp;&nbsp;paddingBottom | `number` | `none` | `true` | Bottom padding in points |
-| animationDuration | `number` | `none` | `false` | The duration the map takes to animate to a new configuration. |
-| animationMode | `\| 'flyTo'
-\| 'easeTo'
-\| 'linearTo'
-\| 'moveTo'
-\| 'none'` | `none` | `false` | The easing or path the camera uses to animate to a new configuration. |
-| followUserMode | `UserTrackingMode` | `none` | `false` | The mode used to track the user location on the map. |
-| followUserLocation | `boolean` | `none` | `false` | Whether the map orientation follows the user location. |
-| followZoomLevel | `number` | `none` | `false` | The zoom level used when following the user location. |
-| followPitch | `number` | `none` | `false` | The pitch used when following the user location. |
-| followHeading | `number` | `none` | `false` | The heading used when following the user location. |
-| minZoomLevel | `number` | `none` | `false` | The lowest allowed zoom level. |
-| maxZoomLevel | `number` | `none` | `false` | The highest allowed zoom level. |
-| maxBounds | `shape` | `none` | `false` | The corners of a box defining the limits of where the camera can pan or zoom. |
-| &nbsp;&nbsp;ne | `Position` | `none` | `true` | FIX ME NO DESCRIPTION |
-| &nbsp;&nbsp;sw | `Position` | `none` | `true` | FIX ME NO DESCRIPTION |
-| defaultSettings | `shape` | `none` | `false` | The configuration that the camera falls back on, if no other values are specified. |
-| &nbsp;&nbsp;type | `literal` | `none` | `false` | Allows static check of the data type. For internal use only. |
-| &nbsp;&nbsp;centerCoordinate | `Position` | `none` | `false` | The location on which the map should center. |
-| &nbsp;&nbsp;bounds | `intersection` | `none` | `false` | The corners of a box around which the map should bound. Contains padding props for backwards<br/>compatibility; the root `padding` prop should be used instead. |
-| &nbsp;&nbsp;heading | `number` | `none` | `false` | The heading (orientation) of the map. |
-| &nbsp;&nbsp;pitch | `number` | `none` | `false` | The pitch of the map. |
-| &nbsp;&nbsp;zoomLevel | `number` | `none` | `false` | The zoom level of the map. |
-| &nbsp;&nbsp;padding | `signature` | `none` | `false` | The viewport padding in points. |
-| &nbsp;&nbsp;animationDuration | `number` | `none` | `false` | The duration the map takes to animate to a new configuration. |
-| &nbsp;&nbsp;animationMode | `union` | `none` | `false` | The easing or path the camera uses to animate to a new configuration. |
-| allowUpdates | `boolean` | `none` | `false` | Whether the camera should send any configuration to the native module. Prevents unnecessary tile<br/>fetching and improves performance when the map is not visible. Defaults to `true`. |
-| triggerKey | `string \| number` | `none` | `false` | Any arbitrary primitive value that, when changed, causes the camera to retry moving to its target<br/>configuration. (Not yet implemented.) |
-| onUserTrackingModeChange | `func` | `none` | `false` | Executes when user tracking mode changes.<br/>*signature:*`(event:MapboxGLEvent) => void` |
-
-## methods
-### setCamera()
-
-Sets any camera properties, with default fallbacks if unspecified.
-
-#### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-camera.current?.setCamera({
-  centerCoordinate: [lon, lat],
-});
-```
-
-
-### fitBounds()
-
-Set the camera position to enclose the provided bounds, with optional<br/>padding and duration.
-
-#### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-camera.fitBounds([lon, lat], [lon, lat]);
-camera.fitBounds([lon, lat], [lon, lat], [20, 0], 1000);
-```
-
-
-### flyTo()
-
-Sets the camera to center around the provided coordinate using a realistic 'travel'<br/>animation, with optional duration.
-
-#### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-camera.flyTo([lon, lat]);
-camera.flyTo([lon, lat], 12000);
-```
-
-
-### moveTo()
-
-Sets the camera to center around the provided coordinate, with optional duration.
-
-#### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-camera.moveTo([lon, lat], 200);
-camera.moveTo([lon, lat]);
-```
-
-
-### zoomTo()
-
-Zooms the camera to the provided level, with optional duration.
-
-#### arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-
-
-
-
-```javascript
-camera.zoomTo(16);
-camera.zoomTo(16, 100);
-```
-
-
-

package/docs/CircleLayer.md

@@ -1,470 +0,0 @@
-<!-- This file was autogenerated from CircleLayer.js do not modify -->
-# <MapboxGL.CircleLayer />
-CircleLayer 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="#circlesortkey">circleSortKey</a><br/>
-* <a href="#visibility">visibility</a><br/>
-* <a href="#circleradius">circleRadius</a><br/>
-* <a href="#circlecolor">circleColor</a><br/>
-* <a href="#circleblur">circleBlur</a><br/>
-* <a href="#circleopacity">circleOpacity</a><br/>
-* <a href="#circletranslate">circleTranslate</a><br/>
-* <a href="#circletranslateanchor">circleTranslateAnchor</a><br/>
-* <a href="#circlepitchscale">circlePitchScale</a><br/>
-* <a href="#circlepitchalignment">circlePitchAlignment</a><br/>
-* <a href="#circlestrokewidth">circleStrokeWidth</a><br/>
-* <a href="#circlestrokecolor">circleStrokeColor</a><br/>
-* <a href="#circlestrokeopacity">circleStrokeOpacity</a><br/>
-
-___
-
-### circleSortKey
-Name: `circleSortKey`
-
-### 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 />
-
-
-
-___
-
-### circleRadius
-Name: `circleRadius`
-
-### Description
-Circle radius.
-
-### Type
-`number`
-### Default Value
-`5`
-
-### Units
-`pixels`
-
-### Minimum
-`0`
-
-
-### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-### Name
-
-`circleRadiusTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s circleRadius property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### circleColor
-Name: `circleColor`
-
-### Description
-The fill color of the circle.
-
-### Type
-`color`
-### Default Value
-`#000000`
-
-
-### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-### Name
-
-`circleColorTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s circleColor property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### circleBlur
-Name: `circleBlur`
-
-### Description
-Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
-
-### Type
-`number`
-### Default Value
-`0`
-
-
-### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-### Name
-
-`circleBlurTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s circleBlur property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### circleOpacity
-Name: `circleOpacity`
-
-### Description
-The opacity at which the circle will be drawn.
-
-### Type
-`number`
-### Default Value
-`1`
-
-### Minimum
-`0`
-
-
-### Maximum
-`1`
-
-### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-### Name
-
-`circleOpacityTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s circleOpacity property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### circleTranslate
-Name: `circleTranslate`
-
-### 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
-
-`circleTranslateTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s circleTranslate property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### circleTranslateAnchor
-Name: `circleTranslateAnchor`
-
-### Description
-Controls the frame of reference for `circleTranslate`.
-
-### Type
-`enum`
-### Default Value
-`map`
-
-### Supported Values
-**map** - The circle is translated relative to the map.<br />
-**viewport** - The circle is translated relative to the viewport.<br />
-
-
-### Requires
-`circleTranslate`
-
-### Expression
-
-Parameters: `zoom`
-
-___
-
-### circlePitchScale
-Name: `circlePitchScale`
-
-### Description
-Controls the scaling behavior of the circle when the map is pitched.
-
-### Type
-`enum`
-### Default Value
-`map`
-
-### Supported Values
-**map** - Circles are scaled according to their apparent distance to the camera.<br />
-**viewport** - Circles are not scaled.<br />
-
-
-### Expression
-
-Parameters: `zoom`
-
-___
-
-### circlePitchAlignment
-Name: `circlePitchAlignment`
-
-### Description
-Orientation of circle when map is pitched.
-
-### Type
-`enum`
-### Default Value
-`viewport`
-
-### Supported Values
-**map** - The circle is aligned to the plane of the map.<br />
-**viewport** - The circle is aligned to the plane of the viewport.<br />
-
-
-### Expression
-
-Parameters: `zoom`
-
-___
-
-### circleStrokeWidth
-Name: `circleStrokeWidth`
-
-### Description
-The width of the circle's stroke. Strokes are placed outside of the `circleRadius`.
-
-### Type
-`number`
-### Default Value
-`0`
-
-### Units
-`pixels`
-
-### Minimum
-`0`
-
-
-### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-### Name
-
-`circleStrokeWidthTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s circleStrokeWidth property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### circleStrokeColor
-Name: `circleStrokeColor`
-
-### Description
-The stroke color of the circle.
-
-### Type
-`color`
-### Default Value
-`#000000`
-
-
-### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-### Name
-
-`circleStrokeColorTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s circleStrokeColor property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### circleStrokeOpacity
-Name: `circleStrokeOpacity`
-
-### Description
-The opacity of the circle's stroke.
-
-### Type
-`number`
-### Default Value
-`1`
-
-### Minimum
-`0`
-
-
-### Maximum
-`1`
-
-### Expression
-
-Parameters: `zoom, feature, feature-state`
-___
-
-### Name
-
-`circleStrokeOpacityTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s circleStrokeOpacity property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-

package/docs/CustomHttpHeaders.md

@@ -1,89 +0,0 @@
-# Custom http headers
-
-Custom headers are implemented using OkHttp interceptor for android and method swizzling for iOS.
-
-[Method swizzling](https://en.wikipedia.org/wiki/Monkey_patch) is done on the `[NSMutableURLRequest requestWithURL:]` to allow adding headers during runtime.
-
-## Prerequisites
-
-### Android
-
-None
-
-### iOS with Mapbox-v10
-
-None
-
-### iOS with Mapbox GL or Mapblibre
-
-To enable this on iOS you need to call `[[MGLCustomHeaders sharedInstance] initHeaders]` pretty early in the lifecycle of the application. This will swizzle the custom method.
-Suggested location is `[AppDelegate application: didFinishLaunchingWithOptions:]`
-
-### Working example (AppDelegate.m)
-
-```obj-c
-// (1) Include the header file
-#import "MGLCustomHeaders.h"
-
-@implementation AppDelegate
-
-- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
-{
-  RCTBridge *bridge = [[RCTBridge alloc] initWithDelegate:self launchOptions:launchOptions];
-  RCTRootView *rootView = [[RCTRootView alloc] initWithBridge:bridge
-                                                   moduleName:@"SampleApp"
-                                            initialProperties:nil];
-  // (2) Init headers, add swizzle method
-  [[MGLCustomHeaders sharedInstance] initHeaders];
-  // (3*) Optionally you can add some global headers here
-  [[MGLCustomHeaders sharedInstance] addHeader:@"IP" forHeaderName:@"X-For-Real"];
-
-  ...
-  return YES;
-}
-
-...
-
-@end
-```
-
-## Sending custom http headers with the tile requests
-
-You can configure sending of custom http headers to your tile server. This is to support custom authentication or custom metadata which can't be included in the url.
-
-You can add and remove headers at runtime.
-
-### To add a header
-
-```javascript
-    MapboxGL.addCustomHeader('Authorization', '{auth header}');
-```
-
-### To remove a header
-
-```javascript
-    MapboxGL.removeCustomHeader('Authorization');
-```
-
-### Working example
-
-```tsx
-export default class HelloWorldApp extends Component {
-  componentDidMount() {
-    MapboxGL.addCustomHeader('Authorization', '{auth header}');
-  }
-
-  render() {
-    MapboxGL.addCustomHeader('X-Some-Header', 'my-value');
-    return (
-      <View style={styles.page}>
-        <View style={styles.container}>
-          <MapboxGL.MapView 
-            style={styles.map} 
-            styleURL={STYLE_URL} />
-        </View>
-      </View>
-    );
-  }
-}
-```