@rnmapbox/maps 10.0.0-beta.28

package/docs/BackgroundLayer.md

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

package/docs/Callout.md

@@ -0,0 +1,15 @@
+<!-- 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 get's 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

@@ -0,0 +1,34 @@
+<!-- This file was autogenerated from Camera.tsx do not modify -->
+## <MapboxGL.Camera />
+### Controls the perspective from which the user sees the map.<br/><br/>To use imperative methods, pass in a ref object:<br/><br/>```<br/>const camera = useRef<Camera>(null);<br/><br/>useEffect(() => {<br/>  camera.current?.setCamera({<br/>    centerCoordinate: [lon, lat],<br/>  });<br/>}, []);<br/><br/>return (<br/>  <Camera ref={camera} /><br/>);<br/>```
+
+### 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 | `{paddingLeft:number;paddingRight:number;paddingTop:number;paddingBottom:number;}` | `none` | `false` | The viewport 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 | `{ne:Position;sw:Position;}` | `none` | `false` | The corners of a box defining the limits of where the camera can pan or zoom. |
+| defaultSettings | `FIX ME FORMAT BIG OBJECT` | `none` | `false` | The configuration that the camera falls back on, if no other values are specified. |
+| 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 | `UserTrackingModeChangeCallback` | `none` | `false` | Executes when user tracking mode changes. |
+
+

package/docs/CircleLayer.md

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