Update docs from maps rnmapbox/maps@12946ef

rnmapbox · Dec 6, 2023 · b777319 · b777319
1 parent 0052174
commit b777319
Show file tree

Hide file tree

Showing 40 changed files with 16 additions and 56 deletions.
diff --git a/docs/components/Annotation.md b/docs/components/Annotation.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Annotation.tsx
 ---
-<!-- This file was autogenerated from Annotation.tsx do not modify -->
 
 
 

diff --git a/docs/components/Atmosphere.md b/docs/components/Atmosphere.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Atmosphere.tsx
 ---
-<!-- This file was autogenerated from Atmosphere.tsx do not modify -->
 
   Mapbox spec: [atmosphere](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#atmosphere)
 

diff --git a/docs/components/BackgroundLayer.md b/docs/components/BackgroundLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/BackgroundLayer.tsx
 ---
-<!-- This file was autogenerated from BackgroundLayer.tsx do not modify -->
 
   Mapbox spec: [background](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#background)
 

diff --git a/docs/components/Callout.md b/docs/components/Callout.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Callout.tsx
 ---
-<!-- This file was autogenerated from Callout.tsx do not modify -->
 
 
 

diff --git a/docs/components/Camera.md b/docs/components/Camera.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Camera.tsx
 ---
-<!-- This file was autogenerated from Camera.tsx do not modify -->
 
 
 
@@ -253,7 +252,7 @@ configuration. (Not yet implemented.)
 func
 ```
 Executes when user tracking mode changes.
-@deprecated use Viewport#onStatusChanged instead.
+**DEPRECATED** use Viewport#onStatusChanged instead.
 *signature:*`(event:MapboxGLEvent) =&gt; void`
 
 

diff --git a/docs/components/CircleLayer.md b/docs/components/CircleLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/CircleLayer.tsx
 ---
-<!-- This file was autogenerated from CircleLayer.tsx do not modify -->
 
   Mapbox spec: [circle](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#circle)
 

diff --git a/docs/components/CustomLocationProvider.md b/docs/components/CustomLocationProvider.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/CustomLocationProvider.tsx
 ---
-<!-- This file was autogenerated from CustomLocationProvider.tsx do not modify -->
 
 
 

diff --git a/docs/components/FillExtrusionLayer.md b/docs/components/FillExtrusionLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/FillExtrusionLayer.tsx
 ---
-<!-- This file was autogenerated from FillExtrusionLayer.tsx do not modify -->
 
   Mapbox spec: [fill-extrusion](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#fill-extrusion)
 

diff --git a/docs/components/FillLayer.md b/docs/components/FillLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/FillLayer.tsx
 ---
-<!-- This file was autogenerated from FillLayer.tsx do not modify -->
 
   Mapbox spec: [fill](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#fill)
 

diff --git a/docs/components/HeadingIndicator.md b/docs/components/HeadingIndicator.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/HeadingIndicator.tsx
 ---
-<!-- This file was autogenerated from HeadingIndicator.tsx do not modify -->
 
 
 

diff --git a/docs/components/HeatmapLayer.md b/docs/components/HeatmapLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/HeatmapLayer.tsx
 ---
-<!-- This file was autogenerated from HeatmapLayer.tsx do not modify -->
 
   Mapbox spec: [heatmap](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#heatmap)
 

diff --git a/docs/components/Image.md b/docs/components/Image.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Image.tsx
 ---
-<!-- This file was autogenerated from Image.tsx do not modify -->
 
 
 

diff --git a/docs/components/ImageSource.md b/docs/components/ImageSource.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/ImageSource.tsx
 ---
-<!-- This file was autogenerated from ImageSource.tsx do not modify -->
 
 
 

diff --git a/docs/components/Images.md b/docs/components/Images.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Images.tsx
 ---
-<!-- This file was autogenerated from Images.tsx do not modify -->
 
 
 
@@ -25,7 +24,7 @@ type Images = {
 ```
 Specifies the external images in key-value pairs required for the shape source.
 Keys are names - see iconImage expressions, values can be either urls-s objects
-with format {uri: 'http://...'}` or `require('image.png')` or `import 'image.png'`
+with format `{uri: 'http://...'}` or `require('image.png')` or `import 'image.png'`
 
 
   

diff --git a/docs/components/Light.md b/docs/components/Light.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Light.tsx
 ---
-<!-- This file was autogenerated from Light.tsx do not modify -->
 
   Mapbox spec: [light](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#light)
 

diff --git a/docs/components/LineLayer.md b/docs/components/LineLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/LineLayer.tsx
 ---
-<!-- This file was autogenerated from LineLayer.tsx do not modify -->
 
   Mapbox spec: [line](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#line)
 

diff --git a/docs/components/LocationPuck.md b/docs/components/LocationPuck.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/LocationPuck.tsx
 ---
-<!-- This file was autogenerated from LocationPuck.tsx do not modify -->
 
 
 

diff --git a/docs/components/MapView.md b/docs/components/MapView.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/MapView.tsx
 ---
-<!-- This file was autogenerated from MapView.tsx do not modify -->
 
 
 
@@ -273,7 +272,7 @@ when embedded into a scroll view
 | true
 ```
 [`mapbox` (v10) implementation only]
-Set map's label locale, e.g. { "locale": "es" } will localize labels to Spanish, { "locale": "current" } will localize labels to system locale.
+Set map's label locale, e.g. `{ "locale": "es" }` will localize labels to Spanish, `{ "locale": "current" }` will localize labels to system locale.
 
 [Localize Labels](../examples/Map/LocalizeLabels)
   
@@ -335,7 +334,7 @@ func
 
 This event is triggered whenever the currently displayed map region is about to change.
 
-@param {PointFeature} feature - The geojson point feature at the camera center, properties contains zoomLevel, visibleBounds
+- `feature`: `PointFeature`  - The geojson point feature at the camera center, properties contains zoomLevel, visibleBounds
 *signature:*`(feature:GeoJSON.Feature) =&gt; void`
 
 [Show Region Did Change](../examples/Map/ShowRegionDidChange)
@@ -347,7 +346,7 @@ func
 ```
 This event is triggered whenever the currently displayed map region is changing.
 
-@param {PointFeature} feature - The geojson point feature at the camera center, properties contains zoomLevel, visibleBounds
+- `feature`: `PointFeature`  - The geojson point feature at the camera center, properties contains zoomLevel, visibleBounds
 *signature:*`(feature:GeoJSON.Feature) =&gt; void`
 
 [Show Region Did Change](../examples/Map/ShowRegionDidChange)
@@ -359,7 +358,7 @@ func
 ```
 This event is triggered whenever the currently displayed map region finished changing.
 
-@param {PointFeature} feature - The geojson point feature at the camera center, properties contains zoomLevel, visibleBounds
+- `feature`: `PointFeature`  - The geojson point feature at the camera center, properties contains zoomLevel, visibleBounds
 *signature:*`(feature:GeoJSON.Feature) =&gt; void`
 
 [Show Region Did Change](../examples/Map/ShowRegionDidChange)
@@ -410,7 +409,7 @@ This is triggered when the map has successfully loaded a new map style.
 func
 ```
 This event is triggered when the map has failed to load a new map style. On v10 it's deprecated and replaced by onMapLoadingError
-@deprecated use onMapLoadingError
+**DEPRECATED** use onMapLoadingError
 *signature:*`() =&gt; void`
 
 

diff --git a/docs/components/MarkerView.md b/docs/components/MarkerView.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/MarkerView.tsx
 ---
-<!-- This file was autogenerated from MarkerView.tsx do not modify -->
 
 
 

diff --git a/docs/components/ModelLayer.md b/docs/components/ModelLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/ModelLayer.tsx
 ---
-<!-- This file was autogenerated from ModelLayer.tsx do not modify -->
 
   Mapbox spec: [model](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#model)
 

diff --git a/docs/components/Models.md b/docs/components/Models.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Models.tsx
 ---
-<!-- This file was autogenerated from Models.tsx do not modify -->
 
 
 

diff --git a/docs/components/PointAnnotation.md b/docs/components/PointAnnotation.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/PointAnnotation.tsx
 ---
-<!-- This file was autogenerated from PointAnnotation.tsx do not modify -->
 
 
 

diff --git a/docs/components/RasterDemSource.md b/docs/components/RasterDemSource.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/RasterDemSource.tsx
 ---
-<!-- This file was autogenerated from RasterDemSource.tsx do not modify -->
 
 
 

diff --git a/docs/components/RasterLayer.md b/docs/components/RasterLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/RasterLayer.tsx
 ---
-<!-- This file was autogenerated from RasterLayer.tsx do not modify -->
 
   Mapbox spec: [raster](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#raster)
 

diff --git a/docs/components/RasterSource.md b/docs/components/RasterSource.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/RasterSource.tsx
 ---
-<!-- This file was autogenerated from RasterSource.tsx do not modify -->
 
 
 

diff --git a/docs/components/ShapeSource.md b/docs/components/ShapeSource.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/ShapeSource.tsx
 ---
-<!-- This file was autogenerated from ShapeSource.tsx do not modify -->
 
 
 
@@ -159,10 +158,10 @@ func
 Source press listener, gets called when a user presses one of the children layers only
 if that layer has a higher z-index than another source layers
 
-@param {Object} event
-@param {Object[]} event.features - the geojson features that have hit by the press (might be multiple)
-@param {Object} event.coordinates - the coordinates of the click
-@param {Object} event.point - the point of the click
+- `event`: `Object` 
+- `event.features`: `Object[]`  - the geojson features that have hit by the press (might be multiple)
+- `event.coordinates`: `Object`  - the coordinates of the click
+- `event.point`: `Object`  - the point of the click
 @return void
 *signature:*`(event:OnPressEvent) =&gt; void`
 

diff --git a/docs/components/SkyLayer.md b/docs/components/SkyLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/SkyLayer.tsx
 ---
-<!-- This file was autogenerated from SkyLayer.tsx do not modify -->
 
   Mapbox spec: [sky](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#sky)
 

diff --git a/docs/components/Style.md b/docs/components/Style.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Style.tsx
 ---
-<!-- This file was autogenerated from Style.tsx do not modify -->
 
 
 

diff --git a/docs/components/StyleImport.md b/docs/components/StyleImport.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/StyleImport.tsx
 ---
-<!-- This file was autogenerated from StyleImport.tsx do not modify -->
 
 
 

diff --git a/docs/components/SymbolLayer.md b/docs/components/SymbolLayer.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/SymbolLayer.tsx
 ---
-<!-- This file was autogenerated from SymbolLayer.tsx do not modify -->
 
   Mapbox spec: [symbol](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#symbol)
 

diff --git a/docs/components/Terrain.md b/docs/components/Terrain.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Terrain.tsx
 ---
-<!-- This file was autogenerated from Terrain.tsx do not modify -->
 
   Mapbox spec: [terrain](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#terrain)
 

diff --git a/docs/components/UserLocation.md b/docs/components/UserLocation.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/UserLocation.tsx
 ---
-<!-- This file was autogenerated from UserLocation.tsx do not modify -->
 
 
 
@@ -129,7 +128,7 @@ Whether location icon is visible
 
 
 ## methods
-### setLocationManager({ running }: { running?: boolean })
+### setLocationManager(&#123; running &#125;: &#123; running?: boolean &#125;)
 
 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
 

diff --git a/docs/components/VectorSource.md b/docs/components/VectorSource.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/VectorSource.tsx
 ---
-<!-- This file was autogenerated from VectorSource.tsx do not modify -->
 
 
 
@@ -104,10 +103,10 @@ func
 Source press listener, gets called when a user presses one of the children layers only
 if that layer has a higher z-index than another source layers
 
-@param {Object} event
-@param {Object[]} event.features - the geojson features that have hit by the press (might be multiple)
-@param {Object} event.coordinates - the coordinates of the click
-@param {Object} event.point - the point of the click
+- `event`: `Object` 
+- `event.features`: `Object[]`  - the geojson features that have hit by the press (might be multiple)
+- `event.coordinates`: `Object`  - the coordinates of the click
+- `event.point`: `Object`  - the point of the click
 *signature:*`(event:OnPressEvent) =&gt; void`
 
 

diff --git a/docs/components/Viewport.md b/docs/components/Viewport.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/components/Viewport.tsx
 ---
-<!-- This file was autogenerated from Viewport.tsx do not modify -->
 
 
 

diff --git a/docs/components/coordinates.md b/docs/components/coordinates.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/modules/location/locationManager.ts
 ---
-<!-- This file was autogenerated from locationManager.ts do not modify -->
 
 
 

diff --git a/docs/components/location.md b/docs/components/location.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/modules/location/locationManager.ts
 ---
-<!-- This file was autogenerated from locationManager.ts do not modify -->
 
 
 

diff --git a/docs/components/locationManager.md b/docs/components/locationManager.md
@@ -1,7 +1,6 @@
 ---
 custom_edit_url: https://github.com/rnmapbox/maps/blob/main/src/modules/location/locationManager.ts
 ---
-<!-- This file was autogenerated from locationManager.ts do not modify -->