@maplibre/maplibre-react-native 10.0.0-alpha.1 → 10.0.0-alpha.10

package/docs/Camera.md

@@ -12,7 +12,7 @@
 | zoomLevel | `number` | `none` | `false` | The zoom level of the map. |
 | padding | `CameraPadding` | `none` | `false` | The viewport padding in points. |
 | animationDuration | `number` | `2000` | `false` | The duration the map takes to animate to a new configuration. |
-| animationMode | `'flyTo' \| 'easeTo' \| 'linearTo' \| 'moveTo'` | `'easeTo'` | `false` | The easing or path the camera uses to animate to a new configuration. |
+| animationMode | `"flyTo" \| "easeTo" \| "linearTo" \| "moveTo"` | `"easeTo"` | `false` | The easing or path the camera uses to animate to a new configuration. |
 | allowUpdates | `boolean` | `true` | `false` | If false, the camera will not send any props to the native module. Intended to be used to prevent unnecessary tile fetching and improve performance when the map is not visible. Defaults to true. |
 | defaultSettings | `CameraStop` | `none` | `false` | Default view settings applied on camera |
 | minZoomLevel | `number` | `none` | `false` | The minimun zoom level of the map |
@@ -34,9 +34,9 @@ Map camera transitions to fit provided bounds
 ##### arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
-| `northEastCoordinates` | `Array` | `Yes` | North east coordinate of bound |
-| `southWestCoordinates` | `Array` | `Yes` | South west coordinate of bound |
-| `padding` | `Number` | `No` | Camera padding for bound |
+| `northEastCoordinates` | `GeoJSON.Position` | `Yes` | North east coordinate of bound |
+| `southWestCoordinates` | `GeoJSON.Position` | `Yes` | South west coordinate of bound |
+| `padding` | `Number \| Array` | `No` | Padding for the bounds |
 | `animationDuration` | `Number` | `No` | Duration of camera animation |
 
 

package/docs/CustomHttpHeaders.md

@@ -14,14 +14,14 @@ None
 
 #### IOS
 
-To enable this on iOS you need to call `[[MGLCustomHeaders sharedInstance] initHeaders]` pretty early in the lifecycle of the application. This will swizzle the custom method.
+To enable this on iOS you need to call `[[MLNCustomHeaders sharedInstance] initHeaders]` pretty early in the lifecycle of the application. This will swizzle the custom method.
 Suggested location is `[AppDelegate application: didFinishLaunchingWithOptions:]`
 
 #### Working example (AppDelegate.m)
 
 ```obj-c
 // (1) Include the header file
-#import "MGLCustomHeaders.h"
+#import "MLNCustomHeaders.h"
 
 @implementation AppDelegate
 
@@ -32,9 +32,9 @@ Suggested location is `[AppDelegate application: didFinishLaunchingWithOptions:]
                                                    moduleName:@"SampleApp"
                                             initialProperties:nil];
   // (2) Init headers, add swizzle method
-  [[MGLCustomHeaders sharedInstance] initHeaders];
+  [[MLNCustomHeaders sharedInstance] initHeaders];
   // (3*) Optionally you can add some global headers here
-  [[MGLCustomHeaders sharedInstance] addHeader:@"IP" forHeaderName:@"X-For-Real"];
+  [[MLNCustomHeaders sharedInstance] addHeader:@"IP" forHeaderName:@"X-For-Real"];
 
   ...
   return YES;

package/docs/MapView.md

@@ -6,50 +6,26 @@
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | contentInset | `number[] \| number` | `none` | `false` | The distance from the edges of the map view’s frame to the edges of the map view’s logical viewport. |
-| style | `ViewProps['style']` | `none` | `false` | Style for wrapping React Native View |
+| style | `ViewProps["style"]` | `none` | `false` | Style for wrapping React Native View |
 | styleURL | `string` | `none` | `false` | Style URL for map - notice, if non is set it _will_ default to `MapLibreGL.StyleURL.Default` |
 | styleJSON | `string` | `none` | `false` | StyleJSON for map - according to TileJSON specs: https://github.com/mapbox/tilejson-spec |
-| 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. |
+| preferredFramesPerSecond | `number` | `none` | `false` | iOS: The preferred frame rate at which the map view is rendered.<br/>The default value for this property is MLNMapViewPreferredFramesPerSecondDefault,<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 | `boolean` | `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 | `boolean` | `none` | `false` | Enable/Disable zoom on the map |
 | scrollEnabled | `boolean` | `true` | `false` | Enable/Disable scroll on the map |
 | pitchEnabled | `boolean` | `true` | `false` | Enable/Disable pitch on map |
 | rotateEnabled | `boolean` | `true` | `false` | Enable/Disable rotation on map |
 | attributionEnabled | `boolean` | `true` | `false` | Enable/Disable attribution on map.<br/><br/>This must be enabled for Mapbox-hosted tiles and styles. Please refer to the Mapbox Terms of Service.<br/>Other providers do not require this. |
-| attributionPosition | `\| {
-    top?: number;
-    left?: number;
-  }
-\| {
-    top?: number;
-    right?: number;
-  }
-\| {
-    bottom?: number;
-    left?: number;
-  }
-\| {
-    bottom?: number;
-    right?: number;
-  }` | `none` | `false` | Adds attribution offset, e.g. `{top: 8, left: 8}` will put attribution button in top-left corner of the map |
+| attributionPosition | `\| { top?: number; left?: number }
+\| { top?: number; right?: number }
+\| { bottom?: number; left?: number }
+\| { bottom?: number; right?: number }` | `none` | `false` | Adds attribution offset, e.g. `{top: 8, left: 8}` will put attribution button in top-left corner of the map |
 | tintColor | `string \| unknown[]` | `none` | `false` | MapView's tintColor |
 | logoEnabled | `boolean` | `false` | `false` | Enable/Disable the logo on the map. |
-| logoPosition | `\| {
-    top?: number;
-    left?: number;
-  }
-\| {
-    top?: number;
-    right?: number;
-  }
-\| {
-    bottom?: number;
-    left?: number;
-  }
-\| {
-    bottom?: number;
-    right?: number;
-  }` | `none` | `false` | Adds logo offset, e.g. `{top: 8, left: 8}` will put the logo in top-left corner of the map |
+| logoPosition | `\| { top?: number; left?: number }
+\| { top?: number; right?: number }
+\| { bottom?: number; left?: number }
+\| { bottom?: number; right?: number }` | `none` | `false` | Adds logo offset, e.g. `{top: 8, left: 8}` will put the logo in top-left corner of the map |
 | compassEnabled | `boolean` | `none` | `false` | Enable/Disable the compass from appearing on the map |
 | compassViewPosition | `number` | `none` | `false` | Change corner of map the compass starts at. 0: TopLeft, 1: TopRight, 2: BottomLeft, 3: BottomRight |
 | compassViewMargins | `object` | `none` | `false` | Add margins to the compass with x and y values |
@@ -108,14 +84,14 @@ const visibleBounds = await this._map.getVisibleBounds();
 ```
 
 
-#### queryRenderedFeaturesAtPoint(coordinate[, filter][, layerIDs])
+#### queryRenderedFeaturesAtPoint(point[, filter][, layerIDs])
 
 Returns an array of rendered map features that intersect with a given point.
 
 ##### arguments
 | Name | Type | Required | Description  |
 | ---- | :--: | :------: | :----------: |
-| `coordinate` | `GeoJSON.Position` | `Yes` | A point expressed in the map view’s coordinate system. |
+| `point` | `tuple` | `Yes` | undefined |
 | `filter` | `FilterExpression` | `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. |
 | `layerIDs` | `Array` | `No` | A array of layer id's to filter the features by |
 

package/docs/MarkerView.md

@@ -6,7 +6,7 @@
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
 | coordinate | `Array` | `none` | `true` | The center point (specified as a map coordinate) of the marker.<br/>See also #anchor. |
-| anchor | `shape` | `{x: 0.5, y: 0.5}` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
+| anchor | `shape` | `{ x: 0.5, y: 0.5 }` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
 | &nbsp;&nbsp;x | `number` | `none` | `true` | `x` of anchor |
 | &nbsp;&nbsp;y | `number` | `none` | `true` | `y` of anchor |
 | allowOverlap | `boolean` | `false` | `false` | FIX ME NO DESCRIPTION |

package/docs/NativeUserLocation.md

@@ -5,7 +5,7 @@
 ### props
 | Prop | Type | Default | Required | Description |
 | ---- | :--: | :-----: | :------: | :----------: |
-| androidRenderMode | `'normal' \| 'compass' \| 'gps'` | `none` | `false` | Android render mode.<br/><br/> - normal: just a circle<br/> - compass: triangle with heading<br/> - gps: large arrow<br/><br/>@platform android |
+| androidRenderMode | `"normal" \| "compass" \| "gps"` | `none` | `false` | Android render mode.<br/><br/> - normal: just a circle<br/> - compass: triangle with heading<br/> - gps: large arrow<br/><br/>@platform android |
 | iosShowsUserHeadingIndicator | `boolean` | `none` | `false` | iOS only. A Boolean value indicating whether the user location annotation may display a permanent heading indicator.<br/><br/>@platform ios |
 
 

package/docs/PointAnnotation.md

@@ -11,11 +11,11 @@
 | selected | `boolean` | `none` | `false` | Manually selects/deselects annotation<br/>@type {[type]} |
 | draggable | `boolean` | `false` | `false` | Enable or disable dragging. Defaults to false. |
 | coordinate | `Array` | `none` | `true` | The center point (specified as a map coordinate) of the annotation. |
-| anchor | `shape` | `{x: 0.5, y: 0.5}` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
+| anchor | `shape` | `{ x: 0.5, y: 0.5 }` | `false` | Specifies the anchor being set on a particular point of the annotation.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
 | &nbsp;&nbsp;x | `number` | `none` | `true` | See anchor |
 | &nbsp;&nbsp;y | `number` | `none` | `true` | See anchor |
 | children | `React.ReactElement \| [React.ReactElement, React.ReactElement]` | `none` | `true` | Expects one child, and an optional callout can be added as well |
-| style | `ViewProps['style']` | `none` | `false` | FIX ME NO DESCRIPTION |
+| style | `ViewProps["style"]` | `none` | `false` | FIX ME NO DESCRIPTION |
 
 ### methods
 #### refresh()

package/docs/UserLocation.md

@@ -6,22 +6,30 @@
 | 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 |
+| 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 |
 | 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})
+#### 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 |
+| `{
+  running,
+}: {
+  running: boolean;
+}` | `{running:boolean;}` | `Yes` | undefined |
 
 
 #### needsLocationManagerRunning()

package/docs/docs.json

@@ -25,24 +25,9 @@
       {
         "name": "symbolStyle",
         "docblock": null,
-        "modifiers": [
-          "get"
-        ],
+        "modifiers": [],
         "params": [],
-        "returns": {
-          "type": {
-            "name": "union",
-            "raw": "SymbolLayerStyleProps | undefined",
-            "elements": [
-              {
-                "name": "SymbolLayerStyleProps"
-              },
-              {
-                "name": "undefined"
-              }
-            ]
-          }
-        }
+        "returns": null
       }
     ],
     "props": [
@@ -232,7 +217,7 @@
         "required": false,
         "type": "ViewStyle",
         "default": "none",
-        "description": "Style property for the native RCTMGLCallout container, set at your own risk."
+        "description": "Style property for the native RCTMLNCallout container, set at your own risk."
       },
       {
         "name": "contentStyle",
@@ -268,14 +253,14 @@
     "methods": [
       {
         "name": "fitBounds",
-        "docblock": "Map camera transitions to fit provided bounds\n\n@example\nthis.camera.fitBounds([lng, lat], [lng, lat])\nthis.camera.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\nthis.camera.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\nthis.camera.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)\n\n@param {Array<Number>} northEastCoordinates - North east coordinate of bound\n@param {Array<Number>} southWestCoordinates - South west coordinate of bound\n@param {Number=} padding - Camera padding for bound\n@param {Number=} animationDuration - Duration of camera animation\n@return {void}",
+        "docblock": "Map camera transitions to fit provided bounds\n\n@example\nthis.camera.fitBounds([lng, lat], [lng, lat])\nthis.camera.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\nthis.camera.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\nthis.camera.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)\n\n@param {Array<Number>} northEastCoordinates - North east coordinate of bound\n@param {Array<Number>} southWestCoordinates - South west coordinate of bound\n@param {Number|Array<Number>|undefined} padding - Padding for the bounds\n@param {Number=} animationDuration - Duration of camera animation\n@return {void}",
         "modifiers": [],
         "params": [
           {
             "name": "northEastCoordinates",
             "description": "North east coordinate of bound",
             "type": {
-              "name": "Array"
+              "name": "GeoJSON.Position"
             },
             "optional": false
           },
@@ -283,15 +268,15 @@
             "name": "southWestCoordinates",
             "description": "South west coordinate of bound",
             "type": {
-              "name": "Array"
+              "name": "GeoJSON.Position"
             },
             "optional": false
           },
           {
             "name": "padding",
-            "description": "Camera padding for bound",
+            "description": "Padding for the bounds",
             "type": {
-              "name": "Number"
+              "name": "Number \\| Array"
             },
             "optional": true
           },
@@ -492,8 +477,8 @@
       {
         "name": "animationMode",
         "required": false,
-        "type": "'flyTo' \\| 'easeTo' \\| 'linearTo' \\| 'moveTo'",
-        "default": "'easeTo'",
+        "type": "\"flyTo\" \\| \"easeTo\" \\| \"linearTo\" \\| \"moveTo\"",
+        "default": "\"easeTo\"",
         "description": "The easing or path the camera uses to animate to a new configuration."
       },
       {
@@ -1586,7 +1571,8 @@
       }
     ],
     "composes": [
-      "BaseProps"
+      "BaseProps",
+      "BaseLayerProps"
     ],
     "fileNameWithExt": "Light.tsx",
     "name": "Light",
@@ -2147,10 +2133,19 @@
             "name": "Promise",
             "elements": [
               {
-                "name": "Bounds"
+                "name": "tuple",
+                "raw": "[northEast: GeoJSON.Position, southWest: GeoJSON.Position]",
+                "elements": [
+                  {
+                    "name": "unknown"
+                  },
+                  {
+                    "name": "unknown"
+                  }
+                ]
               }
             ],
-            "raw": "Promise<Bounds>"
+            "raw": "Promise<VisibleBounds>"
           }
         },
         "description": "The coordinate bounds(ne, sw) visible in the users’s viewport.",
@@ -2166,12 +2161,11 @@
         ],
         "params": [
           {
-            "name": "coordinate",
-            "description": "A point expressed in the map view’s coordinate system.",
+            "name": "point",
+            "optional": false,
             "type": {
-              "name": "GeoJSON.Position"
-            },
-            "optional": false
+              "name": "tuple"
+            }
           },
           {
             "name": "filter",
@@ -2421,7 +2415,7 @@
       {
         "name": "style",
         "required": false,
-        "type": "ViewProps['style']",
+        "type": "ViewProps[\"style\"]",
         "default": "none",
         "description": "Style for wrapping React Native View"
       },
@@ -2444,7 +2438,7 @@
         "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."
+        "description": "iOS: The preferred frame rate at which the map view is rendered.\nThe default value for this property is MLNMapViewPreferredFramesPerSecondDefault,\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",
@@ -2491,7 +2485,7 @@
       {
         "name": "attributionPosition",
         "required": false,
-        "type": "\\| {\n    top?: number;\n    left?: number;\n  }\n\\| {\n    top?: number;\n    right?: number;\n  }\n\\| {\n    bottom?: number;\n    left?: number;\n  }\n\\| {\n    bottom?: number;\n    right?: number;\n  }",
+        "type": "\\| { top?: number; left?: number }\n\\| { top?: number; right?: number }\n\\| { bottom?: number; left?: number }\n\\| { bottom?: number; right?: number }",
         "default": "none",
         "description": "Adds attribution offset, e.g. `{top: 8, left: 8}` will put attribution button in top-left corner of the map"
       },
@@ -2512,7 +2506,7 @@
       {
         "name": "logoPosition",
         "required": false,
-        "type": "\\| {\n    top?: number;\n    left?: number;\n  }\n\\| {\n    top?: number;\n    right?: number;\n  }\n\\| {\n    bottom?: number;\n    left?: number;\n  }\n\\| {\n    bottom?: number;\n    right?: number;\n  }",
+        "type": "\\| { top?: number; left?: number }\n\\| { top?: number; right?: number }\n\\| { bottom?: number; left?: number }\n\\| { bottom?: number; right?: number }",
         "default": "none",
         "description": "Adds logo offset, e.g. `{top: 8, left: 8}` will put the logo in top-left corner of the map"
       },
@@ -2616,7 +2610,7 @@
             }
           ]
         },
-        "default": "{x: 0.5, y: 0.5}",
+        "default": "{ x: 0.5, y: 0.5 }",
         "description": "Specifies the anchor being set on a particular point of the annotation.\nThe anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],\nwhere (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.\nNote this is only for custom annotations not the default pin view.\nDefaults to the center of the view."
       },
       {
@@ -2655,7 +2649,7 @@
       {
         "name": "androidRenderMode",
         "required": false,
-        "type": "'normal' \\| 'compass' \\| 'gps'",
+        "type": "\"normal\" \\| \"compass\" \\| \"gps\"",
         "default": "none",
         "description": "Android render mode.\n\n - normal: just a circle\n - compass: triangle with heading\n - gps: large arrow\n\n@platform android"
       },
@@ -2753,7 +2747,7 @@
             }
           ]
         },
-        "default": "{x: 0.5, y: 0.5}",
+        "default": "{ x: 0.5, y: 0.5 }",
         "description": "Specifies the anchor being set on a particular point of the annotation.\nThe anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],\nwhere (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.\nNote this is only for custom annotations not the default pin view.\nDefaults to the center of the view."
       },
       {
@@ -2766,7 +2760,7 @@
       {
         "name": "style",
         "required": false,
-        "type": "ViewProps['style']",
+        "type": "ViewProps[\"style\"]",
         "default": "none",
         "description": "FIX ME NO DESCRIPTION"
       }
@@ -4769,10 +4763,10 @@
         ],
         "params": [
           {
-            "name": "{running}: {running: boolean}",
+            "name": "{\n  running,\n}: {\n  running: boolean;\n}",
             "optional": false,
             "type": {
-              "name": "{running:boolean}"
+              "name": "{running:boolean;}"
             }
           }
         ],
@@ -4817,14 +4811,14 @@
       {
         "name": "renderMode",
         "required": false,
-        "type": "'normal' \\| 'native'",
-        "default": "'normal'",
+        "type": "\"normal\" \\| \"native\"",
+        "default": "\"normal\"",
         "description": "Which render mode to use.\nCan either be `normal` or `native`"
       },
       {
         "name": "androidRenderMode",
         "required": false,
-        "type": "'normal' \\| 'compass' \\| 'gps'",
+        "type": "\"normal\" \\| \"compass\" \\| \"gps\"",
         "default": "none",
         "description": "native/android only render mode\n\n - normal: just a circle\n - compass: triangle with heading\n - gps: large arrow\n\n@platform android"
       },