@maplibre/maplibre-react-native 10.0.0-alpha.26 → 10.0.0-alpha.28

package/docs/BackgroundLayer.md

@@ -1,166 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/BackgroundLayer.tsx -->
-# `<MapLibreGL.BackgroundLayer />`
-
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| style | `BackgroundLayerStyleProps` | `none` | `false` | Customizable style attributes |
-| sourceID | `FIX ME UNKNOWN TYPE` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | FIX ME NO DESCRIPTION |
-
-
-## Styles
-
-* <a href="#name">`visibility`</a><br/>
-* <a href="#name-1">`backgroundColor`</a><br/>
-* <a href="#name-2">`backgroundPattern`</a><br/>
-* <a href="#name-3">`backgroundOpacity`</a><br/>
-
-
-### `visibility`
-
-Whether this layer is displayed.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>enum</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>visible</code></dd>
-    <dt>Supported Values</dt>
-    <dd>
-        <ul>
-                <li>
-                    <code>visible</code>: The layer is shown.
-                </li>
-                <li>
-                    <code>none</code>: The layer is not shown.
-                </li>
-        </ul>
-    </dd>
-</dl>
-
-
-
-### `backgroundColor`
-
-The color with which the background will be drawn.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>color</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>#000000</code></dd>
-        </ul>
-    </dd>
-        <dt>Disabled By</dt>
-        <dd><code>backgroundPattern</code></dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom</code></dd>
-</dl>
-
-### `backgroundColorTransition`
-
-The transition affecting any changes to this layer’s backgroundColor property.
-
-<dl>
-  <dt>Type</dt>
-  <dd>
-    <code>{ duration, delay }</code>
-  </dd>
-
-  <dt>Units</dt>
-  <dd>
-    <code>milliseconds</code>
-  </dd>
-
-  <dt>Default Value</dt>
-  <dd>
-    <code>{duration: 300, delay: 0}</code>
-  </dd>
-</dl>
-
-
-### `backgroundPattern`
-
-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.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>resolvedImage</code>
-    </dd>
-        </ul>
-    </dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom</code></dd>
-</dl>
-
-### `backgroundPatternTransition`
-
-The transition affecting any changes to this layer’s backgroundPattern property.
-
-<dl>
-  <dt>Type</dt>
-  <dd>
-    <code>{ duration, delay }</code>
-  </dd>
-
-  <dt>Units</dt>
-  <dd>
-    <code>milliseconds</code>
-  </dd>
-
-  <dt>Default Value</dt>
-  <dd>
-    <code>{duration: 300, delay: 0}</code>
-  </dd>
-</dl>
-
-
-### `backgroundOpacity`
-
-The opacity at which the background will be drawn.
-
-<dl>
-    <dt>Type</dt>
-    <dd>
-        <code>number</code>
-    </dd>
-        <dt>Default Value</dt>
-        <dd><code>1</code></dd>
-        </ul>
-    </dd>
-        <dt>Minimum</dt>
-        <dd><code>0</code></dd>
-        <dt>Maximum</dt>
-        <dd><code>1</code></dd>
-        <dt>Expression Parameters</dt>
-        <dd><code>zoom</code></dd>
-</dl>
-
-### `backgroundOpacityTransition`
-
-The transition affecting any changes to this layer’s backgroundOpacity property.
-
-<dl>
-  <dt>Type</dt>
-  <dd>
-    <code>{ duration, delay }</code>
-  </dd>
-
-  <dt>Units</dt>
-  <dd>
-    <code>milliseconds</code>
-  </dd>
-
-  <dt>Default Value</dt>
-  <dd>
-    <code>{duration: 300, delay: 0}</code>
-  </dd>
-</dl>
-

package/docs/Callout.md

@@ -1,16 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/Callout.tsx -->
-# `<MapLibreGL.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 | `ViewStyle` | `none` | `false` | Style property for the Animated.View wrapper, apply animations to this |
-| containerStyle | `ViewStyle` | `none` | `false` | Style property for the native RCTMLNCallout container, set at your own risk. |
-| contentStyle | `ViewStyle` | `none` | `false` | Style property for the content bubble. |
-| tipStyle | `ViewStyle` | `none` | `false` | Style property for the triangle tip under the content. |
-| textStyle | `ViewStyle` | `none` | `false` | Style property for the title in the content bubble. |
-
-

package/docs/Camera.md

@@ -1,132 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/Camera.tsx -->
-# `<MapLibreGL.Camera />`
-
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| centerCoordinate | `GeoJSON.Position` | `none` | `false` | The location on which the map should center. |
-| bounds | `CameraBoundsWithPadding` | `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 | `CameraPadding` | `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` | `false` | The easing or path the camera uses to animate to a new configuration. |
-| defaultSettings | `CameraStop` | `none` | `false` | Default view settings applied on camera |
-| minZoomLevel | `number` | `none` | `false` | Minimum zoom level of the map |
-| maxZoomLevel | `number` | `none` | `false` | Maximum zoom level of the map |
-| maxBounds | `CameraBounds` | `none` | `false` | Restrict map panning so that the center is within these bounds |
-| followUserLocation | `boolean` | `none` | `false` | Should the map orientation follow the user's. |
-| followUserMode | `UserTrackingMode` | `none` | `false` | The mode used to track the user location on the map. One of; "normal", "compass", "course". Each mode string is also available as a member on the `MapLibreGL.UserTrackingModes` object. `Follow` (normal), `FollowWithHeading` (compass), `FollowWithCourse` (course). NOTE: `followUserLocation` must be set to `true` for any of the modes to take effect. [Example](/packages/examples/src/examples/Camera/SetUserTrackingModes.js) |
-| followZoomLevel | `number` | `none` | `false` | The zoomLevel on map while followUserLocation is set to `true` |
-| followPitch | `number` | `none` | `false` | The pitch on map while followUserLocation is set to `true` |
-| followHeading | `number` | `none` | `false` | The heading on map while followUserLocation is set to `true` |
-| onUserTrackingModeChange | `func` | `none` | `false` | Triggered when `followUserLocation` or `followUserMode` changes<br/>*signature:*`(event:MaplibreGLEvent) => void` |
-
-## Methods
-### `fitBounds(ne, sw, [padding], [animationDuration])`
-
-Map camera transitions to fit provided bounds
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `ne` | `GeoJSON.Position` | `Yes` | North east coordinate of bound |
-| `sw` | `GeoJSON.Position` | `Yes` | South west coordinate of bound |
-| `padding` | `number \| number[]` | `No` | Padding for the bounds |
-| `animationDuration` | `number` | `No` | Duration of camera animation |
-
-
-
-```javascript
-cameraRef.current?.fitBounds([lng, lat], [lng, lat])
-cameraRef.current?.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides
-cameraRef.current?.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)
-cameraRef.current?.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)
-```
-
-
-### `flyTo(coordinates, [animationDuration])`
-
-Map camera will fly to new coordinate
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `coordinates` | `GeoJSON.Position` | `Yes` | Coordinates that map camera will jump to |
-| `animationDuration` | `Number` | `No` | Duration of camera animation |
-
-
-
-```javascript
-cameraRef.current?.flyTo([lng, lat])
-cameraRef.current?.flyTo([lng, lat], 12000)
-```
-
-
-### `moveTo(coordinates, [animationDuration])`
-
-Map camera will move to new coordinate at the same zoom level
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `coordinates` | `GeoJSON.Position` | `Yes` | Coordinates that map camera will move too |
-| `animationDuration` | `Number` | `No` | Duration of camera animation |
-
-
-
-```javascript
-cameraRef.current?.moveTo([lng, lat], 200) // eases camera to new location based on duration
-cameraRef.current?.moveTo([lng, lat]) // snaps camera to new location without any easing
-```
-
-
-### `zoomTo(zoomLevel, [animationDuration])`
-
-Map camera will zoom to specified level
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `zoomLevel` | `number` | `Yes` | Zoom level that the map camera will animate too |
-| `animationDuration` | `Number` | `No` | Duration of camera animation |
-
-
-
-```javascript
-cameraRef.current?.zoomTo(16)
-cameraRef.current?.zoomTo(16, 100)
-```
-
-
-### `setCamera([config])`
-
-Map camera will perform updates based on provided config. Advanced use only!
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `config` | `Object` | `No` | Camera configuration |
-
-
-
-```javascript
-cameraRef.current?.setCamera({
-  centerCoordinate: [lng, lat],
-  zoomLevel: 16,
-  animationDuration: 2000,
-})
-
-cameraRef.current?.setCamera({
-  stops: [
-    { pitch: 45, animationDuration: 200 },
-    { heading: 180, animationDuration: 300 },
-  ]
-})
-```
-
-
-