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

package/docs/BackgroundLayer.md

@@ -1,166 +0,0 @@
-<!-- This file was autogenerated from BackgroundLayer.js do not modify -->
-# <MapboxGL.BackgroundLayer />
-
-
-## 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="#visibility">visibility</a><br/>
-* <a href="#backgroundcolor">backgroundColor</a><br/>
-* <a href="#backgroundpattern">backgroundPattern</a><br/>
-* <a href="#backgroundopacity">backgroundOpacity</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 />
-
-
-
-___
-
-### backgroundColor
-Name: `backgroundColor`
-
-### Description
-The color with which the background will be drawn.
-
-### Type
-`color`
-### Default Value
-`#000000`
-
-
-### Disabled By
-`backgroundPattern`
-
-### Expression
-
-Parameters: `zoom`
-___
-
-### Name
-
-`backgroundColorTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s backgroundColor property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### backgroundPattern
-Name: `backgroundPattern`
-
-### Description
-Name of image in sprite to use for drawing an image background. 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`
-___
-
-### Name
-
-`backgroundPatternTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s backgroundPattern property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-
-___
-
-### backgroundOpacity
-Name: `backgroundOpacity`
-
-### Description
-The opacity at which the background will be drawn.
-
-### Type
-`number`
-### Default Value
-`1`
-
-### Minimum
-`0`
-
-
-### Maximum
-`1`
-
-### Expression
-
-Parameters: `zoom`
-___
-
-### Name
-
-`backgroundOpacityTransition`
-
-### Description
-
-The transition affecting any changes to this layer’s backgroundOpacity property.
-
-### Type
-
-`{ duration, delay }`
-
-### Units
-`milliseconds`
-
-### Default Value
-`{duration: 300, delay: 0}`
-
-

package/docs/Callout.md

@@ -1,15 +0,0 @@
-<!-- This file was autogenerated from Callout.js do not modify -->
-# <MapboxGL.Callout />
-Callout that displays information about a selected annotation near the annotation.
-
-## props
-| Prop | Type | Default | Required | Description |
-| ---- | :-- | :----- | :------ | :---------- |
-| title | `string` | `none` | `false` | String that gets displayed in the default callout. |
-| style | `any` | `none` | `false` | Style property for the Animated.View wrapper, apply animations to this |
-| containerStyle | `any` | `none` | `false` | Style property for the native RCTMGLCallout container, set at your own risk. |
-| contentStyle | `any` | `none` | `false` | Style property for the content bubble. |
-| tipStyle | `any` | `none` | `false` | Style property for the triangle tip under the content. |
-| textStyle | `any` | `none` | `false` | Style property for the title in the content bubble. |
-
-

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);
-```
-
-
-