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

package/docs/UserLocation.md

@@ -1,43 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/UserLocation.tsx -->
-# `<MapLibreGL.UserLocation />`
-
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| animated | `boolean` | `true` | `false` | Whether location icon is animated between updates |
-| renderMode | `"normal" \| "native"` | `"normal"` | `false` | Which render mode to use.<br/>Can either be `normal` or `native` |
-| androidRenderMode | `"normal" \| "compass" \| "gps"` | `none` | `false` | native/android only render mode<br/><br/> - normal: just a circle<br/> - compass: triangle with heading<br/> - gps: large arrow<br/><br/>@platform android |
-| visible | `boolean` | `true` | `false` | Whether location icon is visible |
-| showsUserHeadingIndicator | `boolean` | `false` | `false` | Show or hide small arrow which indicates direction the device is pointing relative to north. |
-| minDisplacement | `number` | `0` | `false` | Minimum amount of movement before GPS location is updated in meters |
-| androidPreferredFramesPerSecond | `number` | `none` | `false` | Android only. Set max FPS at which location animators can output updates. Use this setting to limit animation rate of the location puck on higher zoom levels to decrease the stress on the device's CPU which can directly improve battery life, without sacrificing UX.<br/><br/>@platform android |
-| children | `ReactElement \| ReactElement[]` | `none` | `false` | Custom location icon of type mapbox-gl-native components<br/><br/>NOTE: Forking maintainer does not understand the above comment. |
-
-## Methods
-### `setLocationManager({
-  running,
-}: {
-  running: boolean;
-})`
-
-Whether to start or stop listening to the locationManager<br/><br/>Notice, that listening will start automatically when<br/>either `onUpdate` or `visible` are set
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `{
-  running,
-}: {
-  running: boolean;
-}` | `{running:boolean;}` | `Yes` | undefined |
-
-
-### `needsLocationManagerRunning()`
-
-If locationManager should be running
-
-
-
-

package/docs/VectorSource.md

@@ -1,50 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/components/VectorSource.tsx -->
-# `<MapLibreGL.VectorSource />`
-VectorSource is a map content source that supplies tiled vector data in Mapbox Vector Tile format to be shown on the map.<br/>The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification.
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| id | `string` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | A string that uniquely identifies the source. |
-| url | `string` | `none` | `false` | A URL to a TileJSON configuration file describing the source’s contents and other metadata. |
-| tileUrlTemplates | `Array` | `none` | `false` | An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints.<br/>Example: https://example.com/vector-tiles/{z}/{x}/{y}.pbf |
-| minZoomLevel | `number` | `none` | `false` | An unsigned integer that specifies the minimum zoom level at which to display tiles from the source.<br/>The value should be between 0 and 22, inclusive, and less than<br/>maxZoomLevel, if specified. The default value for this option is 0. |
-| maxZoomLevel | `number` | `none` | `false` | An unsigned integer that specifies the maximum zoom level at which to display tiles from the source.<br/>The value should be between 0 and 22, inclusive, and less than<br/>minZoomLevel, if specified. The default value for this option is 22. |
-| tms | `boolean` | `none` | `false` | Influences the y direction of the tile coordinates. (tms inverts y axis) |
-| attribution | `string` | `none` | `false` | An HTML or literal text string defining the buttons to be displayed in an action sheet when the<br/>source is part of a map view’s style and the map view’s attribution button is pressed. |
-| onPress | `func` | `none` | `false` | Source press listener, gets called when a user presses one of the children layers only<br/>if that layer has a higher z-index than another source layers<br/><br/>@param {Object} event<br/>@param {Object[]} event.features - the geojson features that have hit by the press (might be multiple)<br/>@param {Object} event.coordinates - the coordinates of the click<br/>@param {Object} event.point - the point of the click<br/>*signature:*`(event:OnPressEvent) => void` |
-| hitbox | `shape` | `none` | `false` | Overrides the default touch hitbox(44x44 pixels) for the source layers |
-| &nbsp;&nbsp;width | `number` | `none` | `true` | `width` of hitbox |
-| &nbsp;&nbsp;height | `number` | `none` | `true` | `height` of hitbox |
-| children | `React.ReactElement \| React.ReactElement[]` | `none` | `false` | FIX ME NO DESCRIPTION |
-
-## Methods
-### `features([layerIDs], [filter])`
-
-Returns all features that match the query parameters regardless of whether or not the feature is<br/>currently rendered on the map. The domain of the query includes all currently-loaded vector tiles<br/>and GeoJSON source tiles. This function does not check tiles outside of the visible viewport.
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `layerIDs` | `Array` | `No` | A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array. |
-| `filter` | `FilterExpression` | `No` | an optional filter statement to filter the returned Features. |
-
-
-
-```javascript
-vectorSource.features(['id1', 'id2'])
-```
-
-
-### `onPress(event)`
-
-
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `event` | `NativeSyntheticEvent` | `Yes` | undefined |
-
-
-

package/docs/coordinates.md

@@ -1,7 +0,0 @@
-<!-- DO NOT MODIFY! -->
-<!-- This file is auto-generated from javascript/modules/location/locationManager.ts -->
-# `<MapLibreGL.coordinates />`
-Coorinates sent by locationManager
-
-
-