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

package/docs/ShapeSource.md

@@ -1,104 +0,0 @@
-<!-- DO NOT MODIFY -->
-<!-- This file is auto-generated from javascript/components/ShapeSource.tsx -->
-# `<MapLibreGL.ShapeSource />`
-ShapeSource is a map content source that supplies vector shapes to be shown on the map.<br/>The shape may be a url or a GeoJSON object
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| id | `string` | `MapLibreGL.StyleSource.DefaultSourceID` | `false` | A string that uniquely identifies the source. |
-| url | `string` | `none` | `false` | An HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle. |
-| shape | `GeoJSON.GeometryCollection \| GeoJSON.Feature \| GeoJSON.FeatureCollection \| GeoJSON.Geometry` | `none` | `false` | The contents of the source. A shape can represent a GeoJSON geometry, a feature, or a feature colllection. |
-| cluster | `boolean` | `none` | `false` | Enables clustering on the source for point shapes. |
-| clusterRadius | `number` | `none` | `false` | Specifies the radius of each cluster if clustering is enabled.<br/>A value of 512 produces a radius equal to the width of a tile.<br/>The default value is 50. |
-| clusterMaxZoomLevel | `number` | `none` | `false` | Specifies the maximum zoom level at which to cluster points if clustering is enabled.<br/>Defaults to one zoom level less than the value of maxZoomLevel so that, at the maximum zoom level,<br/>the shapes are not clustered. |
-| clusterProperties | `shape` | `none` | `false` | Specifies custom properties on the generated clusters if clustering<br/>is enabled, aggregating values from clustered points.<br/><br/>Has the form `{ "property_name": [operator, map_expression]}`, where<br/> `operator` is a custom reduce expression that references a special `["accumulated"]` value -<br/>  it accumulates the property value from clusters/points the cluster contains<br/> `map_expression` produces the value of a single point<br/><br/>Example: `{ "resultingSum": [["+", ["accumulated"], ["get", "resultingSum"]], ["get", "scalerank"]] }` |
-| &nbsp;&nbsp;[object Object] | `ExpressionField` | `none` | `true` | FIX ME NO DESCRIPTION |
-| maxZoomLevel | `number` | `none` | `false` | Specifies the maximum zoom level at which to create vector tiles.<br/>A greater value produces greater detail at high zoom levels.<br/>The default value is 18. |
-| buffer | `number` | `none` | `false` | Specifies the size of the tile buffer on each side.<br/>A value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself.<br/>Larger values produce fewer rendering artifacts near tile edges and slower performance.<br/>The default value is 128. |
-| tolerance | `number` | `none` | `false` | Specifies the Douglas-Peucker simplification tolerance.<br/>A greater value produces simpler geometries and improves performance.<br/>The default value is 0.375. |
-| lineMetrics | `boolean` | `none` | `false` | Whether to calculate line distance metrics.<br/>This is required for line layers that specify lineGradient values.<br/>The default value is false. |
-| 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/>@return void<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 | `ReactElement \| ReactElement[]` | `none` | `false` | FIX ME NO DESCRIPTION |
-
-## Methods
-### `features([filter])`
-
-Returns all features from the source that match the query parameters regardless of whether or not the feature is<br/>currently rendered on the map.
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `filter` | `FilterExpression` | `No` | an optional filter statement to filter the returned Features. |
-
-
-
-```javascript
-shapeSource.features()
-```
-
-
-### `getClusterExpansionZoom(feature)`
-
-Returns the zoom needed to expand the cluster.
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `feature` | `GeoJSON.Feature` | `Yes` | The feature cluster to expand. |
-
-
-
-```javascript
-const zoom = await shapeSource.getClusterExpansionZoom(clusterId);
-```
-
-
-### `getClusterLeaves(feature, limit, offset)`
-
-Returns the FeatureCollection from the cluster.
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `feature` | `GeoJSON.Feature` | `Yes` | The feature cluster to expand. |
-| `limit` | `number` | `Yes` | The number of points to return. |
-| `offset` | `number` | `Yes` | The amount of points to skip (for pagination). |
-
-
-
-```javascript
-const collection = await shapeSource.getClusterLeaves(clusterId, limit, offset);
-```
-
-
-### `getClusterChildren(feature)`
-
-Returns the FeatureCollection from the cluster (on the next zoom level).
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `feature` | `GeoJSON.Feature` | `Yes` | The feature cluster to expand. |
-
-
-
-```javascript
-const collection = await shapeSource.getClusterChildren(clusterId);
-```
-
-
-### `onPress(event)`
-
-
-
-#### Arguments
-| Name | Type | Required | Description  |
-| ---- | :--: | :------: | :----------: |
-| `event` | `NativeSyntheticEvent` | `Yes` | undefined |
-
-
-

package/docs/Style.md

@@ -1,11 +0,0 @@
-<!-- DO NOT MODIFY -->
-<!-- This file is auto-generated from javascript/components/Style.tsx -->
-# `<MapLibreGL.Style />`
-Style is a component that automatically adds sources / layers to the map using MapLibre Style Spec.<br/>Only [`sources`](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/) & [`layers`](https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/) are supported.<br/>Other fields such as `sprites`, `glyphs` etc. will be ignored. Not all layer / source attributes from the style spec are supported, in general the supported attributes will be mentioned under https://github.com/maplibre/maplibre-react-native/tree/main/docs.<br/><br/>TODO: Maintainer forking this project does not understand the above comment regarding what is supported.
-
-## Props
-| Prop | Type | Default | Required | Description |
-| ---- | :--: | :-----: | :------: | :----------: |
-| json | `MaplibreJSON \| URL` | `none` | `false` | A JSON object conforming to the schema described in the MapLibre Style Specification, or a URL to such JSON. |
-
-

package/docs/StyleSheet.md

@@ -1,451 +0,0 @@
-## StyleSheet
-
-
-### Stylesheet is now a JS object, see [CHANGELOG.md](../CHANGELOG.md)  for more details
-
-See (MapLibre expression specs)[https://maplibre.org/maplibre-gl-js-docs/style-spec/expressions/] for reference on expressions.
-
-### Style functions
-
-#### zoom based expressions (replaces camera(stops[, interpolationMode]))
-
-This is a value function defining a style value that changes as the zoom level changes. The layout and paint attribute properties of the layer can be set to style function objects. Use a camera function to create the illusion of depth and control data density.
-
-new:
-```js
-// color would change based on zoom level keys.
-[
-  'interpolate',
-  ['exponential', 1.5],
-  ['zoom'],
-  0, 'blue',
-  10, 'green',
-  20, 'yellow'
-];
-
-// Example of use inside stylesheet
-{
-  fillColor: [
-    'step',
-    ['zoom'],
-    'blue',
-    20, 'green'
-  ]
-}
-```
-
-old:
-
-```js
-// color would change based on zoom level keys.
-MapLibreGL.StyleSheet.camera({
-  0: 'blue',
-  10: 'green',
-  20: 'yellow',
-}, MapLibreGL.InterpolationMode.Exponential);
-
-// Example of use inside stylesheet
-MapLibreGL.StyleSheet.create({
-  fillColor: MapLibreGL.StyleSheet.camera({
-    15: 'blue',
-    20: 'green',
-  }, MapLibreGL.InterpolationMode.Interval),
-});
-```
-
-#### attribute based expressions (replaces source(stops, attributeName[, interpolationMode]))
-
-This is a value function defining a style value that changes with its properties. The layout and paint attribute properties of the layer can be set to style function objects. Use source functions to visually differentate types of features within the same layer or create data visualizations.
-
-new:
-```js
-// would color the layer based the property rating=[1, 5]
-[
-  'step',
-  ['get', 'rating'],
-  'red',
-  2, 'orange',
-  3, 'yellow',
-  4, 'yellowgreen',
-  5, 'green',
-];
-
-// Example of use inside stylesheet
-{
-  circleColor: [
-    'step',
-    ['get', 'rating'],
-    'red',
-    2, 'orange',
-    3, 'yellow',
-    4, 'yellowgreen',
-    5, 'green',
-  ],
-}
-```
-
-
-old:
-
-```js
-// would color the layer based the property rating=[1, 5]
-MapLibreGL.StyleSheet.source([
-  [1, 'red'],
-  [2, 'orange'],
-  [3, 'yellow'],
-  [4, 'yellowgreen'],
-  [5, 'green'],
-], 'rating', MapLibreGL.InterpolationMode.Categorical);
-
-// Example of use inside stylesheet
-MapLibreGL.StyleSheet.create({
-  circleColor: MapLibreGL.StyleSheet.source([
-    [1, 'red'],
-    [2, 'orange'],
-    [3, 'yellow'],
-    [4, 'yellowgreen'],
-    [5, 'green'],
-  ], 'rating', MapLibreGL.InterpolationMode.Categorical),
-});
-```
-
-#### nested expressions (replaces composite(stops, attributeName[, interpolationMode]))
-
-This is a value function defining a style value that changes with the feature attributes at each map zoom level. The layout and paint attribute properties of the layer can be set to style function objects. Use composite functions to allow the appearance of a map feature to change with both its attributes and the map zoom level. Note that support for composite functions is not yet complete in the Android/iOS SDK's.
-
-new: 
-```js
-// would change based on the zoom level and rating value
-// {zoom_level}: [{value}, {style_value}]
-[
-  'step',
-  ['zoom'],
-  [
-    'step',
-    ['get','rating'],
-    0,
-    5, 5
-  ],
-  20, [
-    'step',
-    ['get','rating'],
-    0,
-    5, 20
-  ]
-]
-
-{
-  circleRadius: [
-    'step',
-    ['zoom'],
-    [ 'step',
-      ['get','rating'],
-      0,
-      5, 5
-    ],
-    20, [ 'step',
-          ['get','rating'],
-          0,
-          5, 20
-        ],
-]
-};
-```
-
-
-old:
-
-```js
-// would change based on the zoom level and rating value
-// {zoom_level}: [{value}, {style_value}]
-MapLibreGL.StyleSheet.composite({
-  0: [0, 0],
-  0: [5, 5],
-  20: [0, 0],
-  20: [5, 20],
-}, 'rating', MapLibreGL.InterpolationMode.Interval);
-
-MapLibreGL.StyleSheet.create({
-  circleRadius: MapLibreGL.StyleSheet.composite({
-    0: [0, 0],
-    0: [5, 5],
-    20: [0, 0],
-    20: [5, 20],
-  }, 'rating', MapLibreGL.InterpolationMode.Interval),
-});
-```
-
-### Simple expressions 
-
-#### ['get', attributeName] - replaces identity(attributeName)
-
-This is just a source style function under the hood. For example say if you had a feature property with an attribute height. Identity means that it will just equal the attribute value, so there is no need to provide any stops
-
-new: 
-```js
-{
-  fillExtrusionHeight: ['get', 'height'],
-}
-```
-
-old:
-
-```js
-MapLibreGL.StyleSheet.create({
-  fillExtrusionHeight: MapLibreGL.StyleSheet.identity('height'),
-});
-```
-
-### StyleSheet Examples
-
-
-#### new:
-
-```js
-const styles = {
-  buildings: {
-    fillColor: 'blue',
-  },
-  street: {
-    lineColor: 'green',
-  }
-};
-
-...
-
-<MapLibreGL.FillLayer ... style={styles.buildings} />
-<MapLibreGL.FillLayer ... style={styles.street} />
-```
-
-```js
-const layerStyles = {
-  singlePoint: {
-    circleColor: 'green',
-    circleOpacity: 0.84,
-    circleStrokeWidth: 2,
-    circleStrokeColor: 'white',
-    circleRadius: 5,
-  },
-
-  clusteredPoints: {
-    circleColor: [
-      'interpolate',
-      ['exponential', 1.5],
-      ['get','point_count'],
-      25, 'yellow',
-      50, 'red',
-      75, 'blue',
-      100, 'orange',
-      300, 'pink',
-      750, 'white',
-    ],
-
-    circleRadius: [
-      'interpolate',
-      ['exponential', 1.5],
-      ['get','point_count'],
-      [0, 15],
-      [100, 20],
-      [750, 30],
-    ],
-
-    circleOpacity: 0.84,
-    circleStrokeWidth: 2,
-    circleStrokeColor: 'white',
-  },
-
-  clusterCount: {
-    textField: ['get', 'point_count'],
-    textSize: 12,
-  },
-});
-
-...
-
-<MapLibreGL.SymbolLayer
-  id='pointCount'
-  style={layerStyles.clusterCount} />
-
-<MapLibreGL.CircleLayer
-  id='clusteredPoints'
-  belowLayerID='pointCount'
-  filter={['has', 'point_count']}
-  style={layerStyles.clusteredPoints} />
-
-<MapLibreGL.CircleLayer
-  id='singlePoint'
-  filter={['!has', 'point_count']}
-  style={layerStyles.singlePoint} />
-```
-
-```javascript
-const layerStyles = MapLibreGL.StyleSheet.create({
-    building: {
-      fillExtrusionOpacity: 1,
-      fillExtrusionHeight: ['get', 'height'],
-      fillExtrusionBase: ['get', 'min_height'],
-      fillExtrusionColor: [
-        'interpolate',
-        ['exponential', 1.5],
-        ['get', 'height'],
-        [0, 'white'],
-        [50, 'blue'],
-        [100, 'red'],
-      ],
-    },
-    fillExtrusionColorTransition: { duration: 2000, delay: 0 },
-  },
-  streets
-:
-{
-  lineColor: 'blue',
-    lineWidth
-:
-  2,
-    lineOpacity
-:
-  0.50,
-    lineJoin
-:
-  MapLibreGL.LineJoin.Round,
-    lineCap
-:
-  MapLibreGL.LineCap.Round,
-    lineDasharray
-:
-  [2, 2],
-}
-,
-})
-;
-
-...
-
-<MapLibreGL.FillExtrusionLayer
-  id='building3d'
-  sourceLayerID='building'
-  style={layerStyles.building}/>
-
-<MapLibreGL.LineLayer
-  id='streetLineColor'
-  sourceLayerID='road'
-  minZoomLevel={14}
-  belowLayerID='building3d'
-  style={layerStyles.streets}/>
-```
-
-#### old:
-
-```js
-const styles = MapLibreGL.StyleSheet.create({
-  buildings: {
-    fillColor: 'blue',
-  },
-  street: {
-    lineColor: 'green',
-  }
-});
-
-...
-
-<MapLibreGL.FillLayer ...
-style = { styles.buildings }
-/>
-<MapLibreGL.FillLayer ...
-style = { styles.street }
-/>
-```
-
-```js
-const layerStyles = MapLibreGL.StyleSheet.create({
-  singlePoint: {
-    circleColor: 'green',
-    circleOpacity: 0.84,
-    circleStrokeWidth: 2,
-    circleStrokeColor: 'white',
-    circleRadius: 5,
-  },
-
-  clusteredPoints: {
-    circleColor: MapLibreGL.StyleSheet.source([
-      [25, 'yellow'],
-      [50, 'red'],
-      [75, 'blue'],
-      [100, 'orange'],
-      [300, 'pink'],
-      [750, 'white'],
-    ], 'point_count', MapLibreGL.InterpolationMode.Exponential),
-
-    circleRadius: MapLibreGL.StyleSheet.source([
-      [0, 15],
-      [100, 20],
-      [750, 30],
-    ], 'point_count', MapLibreGL.InterpolationMode.Exponential),
-
-    circleOpacity: 0.84,
-    circleStrokeWidth: 2,
-    circleStrokeColor: 'white',
-  },
-
-  clusterCount: {
-    textField: '{point_count}',
-    textSize: 12,
-  },
-});
-
-...
-
-<MapLibreGL.SymbolLayer
-  id='pointCount'
-  style={layerStyles.clusterCount}/>
-
-<MapLibreGL.CircleLayer
-  id='clusteredPoints'
-  belowLayerID='pointCount'
-  filter={['has', 'point_count']}
-  style={layerStyles.clusteredPoints}/>
-
-<MapLibreGL.CircleLayer
-  id='singlePoint'
-  filter={['!has', 'point_count']}
-  style={layerStyles.singlePoint}/>
-```
-
-```javascript
-const layerStyles = MapLibreGL.StyleSheet.create({
-  building: {
-    fillExtrusionOpacity: 1,
-    fillExtrusionHeight: MapLibreGL.StyleSheet.identity('height'),
-    fillExtrusionBase: MapLibreGL.StyleSheet.identity('min_height'),
-    fillExtrusionColor: MapLibreGL.StyleSheet.source([
-      [0, 'white'],
-      [50, 'blue'],
-      [100, 'red'],
-    ], 'height', MapLibreGL.InterpolationMode.Exponential),
-    fillExtrusionColorTransition: { duration: 2000, delay: 0 },
-  },
-  streets: {
-    lineColor: 'blue',
-    lineWidth: 2,
-    lineOpacity: 0.50,
-    lineJoin: MapLibreGL.LineJoin.Round,
-    lineCap: MapLibreGL.LineCap.Round,
-    lineDasharray: [2, 2],
-  },
-});
-
-...
-
-<MapLibreGL.FillExtrusionLayer
-  id='building3d'
-  sourceLayerID='building'
-  style={layerStyles.building} />
-
-<MapLibreGL.LineLayer
-  id='streetLineColor'
-  sourceLayerID='road'
-  minZoomLevel={14}
-  belowLayerID='building3d'
-  style={layerStyles.streets} />
-```
-