#236 iOS Snapshotter as __block variable (#369)

* FIX-236 iOS snapshot manager by setting snapshotter to __block variable

* FIX-236 Also deallocate from error block

* Allow toggling of snapshot logo for Android

* Allow disable logo for Android snapshot manager

* Update tests

* Update documentation and add info to CONTRIBUTING.md about documentation generator

Author: kristfal

CONTRIBUTING.md

@@ -17,3 +17,10 @@ commit the changes and push them to a fork for creating a pull request.
 
 1. If you add a feature, make sure you add it to the documentation
 1. If you add an objective-c or java method, make sure you update the declaration file: `index.d.ts`.
+
+
+## Documentation
+
+1. Documentation is auto-generated from code blocks and comments. To generate documentation:
+  1. `npm install -g documentation` to install documentation generator
+  1. `npm run generate` to generate updated documentation

__tests__/modules/snapshot/SnapshotOptions.test.js

@@ -25,6 +25,7 @@ describe('SnapshotOptions', () => {
       height: 50.0,
       writeToDisk: false,
       centerCoordinate: JSON.stringify(makePoint(centerCoordinate)),
+      withLogo: true,
     });
   });
 
@@ -37,6 +38,7 @@ describe('SnapshotOptions', () => {
       width: 314,
       height: 600,
       writeToDisk: true,
+      withLogo: true,
       styleURL: NativeModules.MGLModule.StyleURL.Dark,
     };
 
@@ -56,6 +58,7 @@ describe('SnapshotOptions', () => {
       height: 600,
       styleURL: NativeModules.MGLModule.StyleURL.Light,
       writeToDisk: false,
+      withLogo: true,
     };
 
     const geoJSONBounds = JSON.stringify(

android/rctmgl/src/main/java/com/mapbox/rctmgl/modules/RCTMGLSnapshotModule.java

@@ -105,6 +105,7 @@ private MapSnapshotter.Options getOptions(ReadableMap jsOptions) {
                 (int) jsOptions.getDouble("width"),
                 (int) jsOptions.getDouble("height"));
 
+        options.withLogo(jsOptions.getBoolean("withLogo"));
         options.withStyle(jsOptions.getString("styleURL"));
         options.withPixelRatio(Float.valueOf(mContext.getResources().getDisplayMetrics().scaledDensity).intValue());
 

docs/Annotation.md

@@ -10,6 +10,8 @@
 | animationEasingFunction | `func` | `Easing.linear` | `false` | FIX ME NO DESCRIPTION |
 | coordinates | `array` | `none` | `false` | FIX ME NO DESCRIPTION |
 | onPress | `func` | `none` | `false` | FIX ME NO DESCRIPTION |
+| children | `any` | `none` | `false` | FIX ME NO DESCRIPTION |
+| style | `any` | `none` | `false` | FIX ME NO DESCRIPTION |
 | icon | `union` | `none` | `false` | FIX ME NO DESCRIPTION |
 
 ### methods

docs/Camera.md

@@ -38,6 +38,7 @@
 | followHeading | `number` | `none` | `false` | FIX ME NO DESCRIPTION |
 | triggerKey | `any` | `none` | `false` | FIX ME NO DESCRIPTION |
 | alignment | `array` | `none` | `false` | FIX ME NO DESCRIPTION |
+| onUserTrackingModeChange | `func` | `none` | `false` | FIX ME NO DESCRIPTION |
 | isUserInteraction | `FIX ME UNKNOWN TYPE` | `false` | `false` | FIX ME NO DESCRIPTION |
 
 ### methods

docs/MapView.md

@@ -7,6 +7,7 @@
 | contentInset | `union` | `none` | `false` | The distance from the edges of the map view’s frame to the edges of the map view’s logical viewport. |
 | style | `any` | `none` | `false` | Style for wrapping React Native View |
 | styleURL | `string` | `MapboxGL.StyleURL.Street` | `false` | Style URL for map |
+| preferredFramesPerSecond | `number` | `none` | `false` | iOS: The preferred frame rate at which the map view is rendered.<br/>The default value for this property is MGLMapViewPreferredFramesPerSecondDefault,<br/>which will adaptively set the preferred frame rate based on the capability of<br/>the user’s device to maintain a smooth experience. This property can be set to arbitrary integer values.<br/><br/>Android: The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.<br/>This property can be set to arbitrary integer values. |
 | localizeLabels | `bool` | `false` | `false` | Automatically change the language of the map labels to the system’s preferred language,<br/>this is not something that can be toggled on/off |
 | zoomEnabled | `bool` | `none` | `false` | Enable/Disable zoom on the map |
 | scrollEnabled | `bool` | `true` | `false` | Enable/Disable scroll on the map |
@@ -30,6 +31,7 @@
 | onWillStartRenderingMap | `func` | `none` | `false` | This event is triggered when the map will start rendering the map. |
 | onDidFinishRenderingMap | `func` | `none` | `false` | This event is triggered when the map finished rendering the map. |
 | onDidFinishRenderingMapFully | `func` | `none` | `false` | This event is triggered when the map fully finished rendering the map. |
+| onUserLocationUpdate | `func` | `none` | `false` | This event is triggered when the user location is updated. |
 | onDidFinishLoadingStyle | `func` | `none` | `false` | This event is triggered when a style has finished loading. |
 | regionWillChangeDebounceTime | `number` | `10` | `false` | The emitted frequency of regionwillchange events |
 | regionDidChangeDebounceTime | `number` | `500` | `false` | The emitted frequency of regiondidchange events |
@@ -119,14 +121,14 @@ this._map.queryRenderedFeaturesInRect([30, 40, 20, 10], ['==', 'type', 'Point'],
 ```
 
 
-#### setCamera(config)
+#### setCamera()
 
 Map camera will perform updates based on provided config. Deprecated use Camera#setCamera.
 
 ##### arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
-| `config` | `n/a` | `Yes` | undefined |
+
 
 
 #### takeSnap(writeToDisk)

docs/PointAnnotation.md

@@ -1,5 +1,3 @@
-_**deprecated and buggy, use [SymbolLayer](https://github.com/react-native-mapbox-gl/maps/blob/master/docs/SymbolLayer.md) instead**_
-
 ## <MapboxGL.PointAnnotation />
 ### PointAnnotation represents a one-dimensional shape located at a single geographical coordinate. PointAnnotation is legacy, soon to be deprecated, and should use ShapeSource and SymbolLayer instead.
 

docs/VectorSource.md

@@ -11,4 +11,22 @@
 |   width | `number` | `none` | `true` | FIX ME NO DESCRIPTION |
 |   height | `number` | `none` | `true` | 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` | `Array` | `No` | an optional filter statement to filter the returned Features. |
+
+
+
+```javascript
+vectorSource.features(['id1', 'id2'])
+```
+
+
 

docs/docs.json

@@ -684,6 +684,13 @@
         "default": "none",
         "description": "FIX ME NO DESCRIPTION"
       },
+      {
+        "name": "onUserTrackingModeChange",
+        "required": false,
+        "type": "func",
+        "default": "none",
+        "description": "FIX ME NO DESCRIPTION"
+      },
       {
         "name": "isUserInteraction",
         "required": false,
@@ -2488,11 +2495,7 @@
         "name": "setCamera",
         "docblock": "Map camera will perform updates based on provided config. Deprecated use Camera#setCamera.",
         "modifiers": [],
-        "params": [
-          {
-            "name": "config"
-          }
-        ],
+        "params": [],
         "returns": null,
         "description": "Map camera will perform updates based on provided config. Deprecated use Camera#setCamera.",
         "examples": []
@@ -2574,27 +2577,6 @@
       }
     ],
     "props": [
-      {
-        "name": "showUserLocation",
-        "required": false,
-        "type": "bool",
-        "default": "none",
-        "description": "Shows the users location on the map"
-      },
-      {
-        "name": "userTrackingMode",
-        "required": false,
-        "type": "number",
-        "default": "none",
-        "description": "The mode used to track the user location on the map"
-      },
-      {
-        "name": "userLocationVerticalAlignment",
-        "required": false,
-        "type": "number",
-        "default": "none",
-        "description": "The vertical alignment of the user location within in map. This is only enabled while tracking the users location."
-      },
       {
         "name": "contentInset",
         "required": false,
@@ -2616,6 +2598,13 @@
         "default": "MapboxGL.StyleURL.Street",
         "description": "Style URL for map"
       },
+      {
+        "name": "preferredFramesPerSecond",
+        "required": false,
+        "type": "number",
+        "default": "none",
+        "description": "iOS: The preferred frame rate at which the map view is rendered.\nThe default value for this property is MGLMapViewPreferredFramesPerSecondDefault,\nwhich will adaptively set the preferred frame rate based on the capability of\nthe user’s device to maintain a smooth experience. This property can be set to arbitrary integer values.\n\nAndroid: The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.\nThis property can be set to arbitrary integer values."
+      },
       {
         "name": "localizeLabels",
         "required": false,
@@ -2807,6 +2796,13 @@
         "default": "none",
         "description": "This event is triggered when the map fully finished rendering the map."
       },
+      {
+        "name": "onUserLocationUpdate",
+        "required": false,
+        "type": "func",
+        "default": "none",
+        "description": "This event is triggered when the user location is updated."
+      },
       {
         "name": "onDidFinishLoadingStyle",
         "required": false,
@@ -4705,7 +4701,9 @@
       {
         "name": "setLocationManager",
         "docblock": null,
-        "modifiers": [],
+        "modifiers": [
+          "async"
+        ],
         "params": [
           {
             "name": "{running}",
@@ -4780,7 +4778,43 @@
   "VectorSource": {
     "description": "VectorSource is a map content source that supplies tiled vector data in Mapbox Vector Tile format to be shown on the map.\nThe 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.",
     "displayName": "VectorSource",
-    "methods": [],
+    "methods": [
+      {
+        "name": "features",
+        "docblock": "Returns all features that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map. The domain of the query includes all currently-loaded vector tiles\nand GeoJSON source tiles. This function does not check tiles outside of the visible viewport.\n\n@example\nvectorSource.features(['id1', 'id2'])\n\n@param  {Array=} layerIDs - 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.\n@param  {Array=} filter - an optional filter statement to filter the returned Features.\n@return {FeatureCollection}",
+        "modifiers": [
+          "async"
+        ],
+        "params": [
+          {
+            "name": "layerIDs",
+            "description": "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.",
+            "type": {
+              "name": "Array"
+            },
+            "optional": true
+          },
+          {
+            "name": "filter",
+            "description": "an optional filter statement to filter the returned Features.",
+            "type": {
+              "name": "Array"
+            },
+            "optional": true
+          }
+        ],
+        "returns": {
+          "description": null,
+          "type": {
+            "name": "FeatureCollection"
+          }
+        },
+        "description": "Returns all features that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map. The domain of the query includes all currently-loaded vector tiles\nand GeoJSON source tiles. This function does not check tiles outside of the visible viewport.",
+        "examples": [
+          "\nvectorSource.features(['id1', 'id2'])\n\n"
+        ]
+      }
+    ],
     "props": [
       {
         "name": "id",
@@ -4903,6 +4937,20 @@
         "default": "none",
         "description": "FIX ME NO DESCRIPTION"
       },
+      {
+        "name": "children",
+        "required": false,
+        "type": "any",
+        "default": "none",
+        "description": "FIX ME NO DESCRIPTION"
+      },
+      {
+        "name": "style",
+        "required": false,
+        "type": "any",
+        "default": "none",
+        "description": "FIX ME NO DESCRIPTION"
+      },
       {
         "name": "icon",
         "required": false,
@@ -5148,7 +5196,7 @@
           }
         ],
         "examples": [
-          "// creates a temp file png of base map\nconst uri = await MapboxGL.snapshotManager.takeSnap({\n  centerCoordinate: [-74.126410, 40.797968],\n  width: width,\n  height: height,\n  zoomLevel: 12,\n  pitch: 30,\n  heading: 20,\n  styleURL: MapboxGL.StyleURL.Dark,\n  writeToDisk: true, // creates a temp file\n});\n\n// creates base64 png of base map\nconst uri = await MapboxGL.snapshotManager.takeSnap({\n  centerCoordinate: [-74.126410, 40.797968],\n  width: width,\n  height: height,\n  zoomLevel: 12,\n  pitch: 30,\n  heading: 20,\n  styleURL: MapboxGL.StyleURL.Dark,\n});\n\n// creates snapshot with bounds\nconst uri = await MapboxGL.snapshotManager.takeSnap({\n  bounds: [[-74.126410, 40.797968], [-74.143727, 40.772177]],\n  width: width,\n  height: height,\n  styleURL: MapboxGL.StyleURL.Dark,\n});"
+          "// creates a temp file png of base map\nconst uri = await MapboxGL.snapshotManager.takeSnap({\n  centerCoordinate: [-74.126410, 40.797968],\n  width: width,\n  height: height,\n  zoomLevel: 12,\n  pitch: 30,\n  heading: 20,\n  styleURL: MapboxGL.StyleURL.Dark,\n  writeToDisk: true, // Create a temporary file\n});\n\n// creates base64 png of base map without logo\nconst uri = await MapboxGL.snapshotManager.takeSnap({\n  centerCoordinate: [-74.126410, 40.797968],\n  width: width,\n  height: height,\n  zoomLevel: 12,\n  pitch: 30,\n  heading: 20,\n  styleURL: MapboxGL.StyleURL.Dark,\n  withLogo: false, // Disable Mapbox logo (Android only)\n});\n\n// creates snapshot with bounds\nconst uri = await MapboxGL.snapshotManager.takeSnap({\n  bounds: [[-74.126410, 40.797968], [-74.143727, 40.772177]],\n  width: width,\n  height: height,\n  styleURL: MapboxGL.StyleURL.Dark,\n});"
         ],
         "returns": {
           "description": "",

docs/snapshotManager.md

@@ -24,10 +24,10 @@ const uri = await MapboxGL.snapshotManager.takeSnap({
   pitch: 30,
   heading: 20,
   styleURL: MapboxGL.StyleURL.Dark,
-  writeToDisk: true, // creates a temp file
+  writeToDisk: true, // Create a temporary file
 });
 
-// creates base64 png of base map
+// creates base64 png of base map without logo
 const uri = await MapboxGL.snapshotManager.takeSnap({
   centerCoordinate: [-74.126410, 40.797968],
   width: width,
@@ -36,6 +36,7 @@ const uri = await MapboxGL.snapshotManager.takeSnap({
   pitch: 30,
   heading: 20,
   styleURL: MapboxGL.StyleURL.Dark,
+  withLogo: false, // Disable Mapbox logo (Android only)
 });
 
 // creates snapshot with bounds