react-native-mapbox-gl/docs/docs.json

{
  "javascript/components/MapView.js": {
    "description": "MapView backed by Mapbox Native GL",
    "methods": [
      {
        "name": "fitBounds",
        "docblock": null,
        "modifiers": [],
        "params": [
          {
            "name": "northEastCoordinates",
            "type": null
          },
          {
            "name": "southWestCoordinates",
            "type": null
          },
          {
            "name": "padding",
            "type": null
          },
          {
            "name": "duration",
            "type": null
          }
        ],
        "returns": null
      },
      {
        "name": "flyTo",
        "docblock": null,
        "modifiers": [],
        "params": [
          {
            "name": "coordinates",
            "type": null
          },
          {
            "name": "duration",
            "type": null
          }
        ],
        "returns": null
      },
      {
        "name": "setCamera",
        "docblock": null,
        "modifiers": [],
        "params": [
          {
            "name": "config",
            "type": null
          }
        ],
        "returns": null
      },
      {
        "name": "_onPress",
        "docblock": null,
        "modifiers": [],
        "params": [
          {
            "name": "e",
            "type": null
          }
        ],
        "returns": null
      },
      {
        "name": "_onLongPress",
        "docblock": null,
        "modifiers": [],
        "params": [
          {
            "name": "e",
            "type": null
          }
        ],
        "returns": null
      },
      {
        "name": "_onUserLocationChange",
        "docblock": null,
        "modifiers": [],
        "params": [
          {
            "name": "e",
            "type": null
          }
        ],
        "returns": null
      },
      {
        "name": "_onChange",
        "docblock": null,
        "modifiers": [],
        "params": [
          {
            "name": "e",
            "type": null
          }
        ],
        "returns": null
      },
      {
        "name": "_handleOnChange",
        "docblock": null,
        "modifiers": [],
        "params": [
          {
            "name": "propName",
            "type": null
          },
          {
            "name": "payload",
            "type": null
          }
        ],
        "returns": null
      },
      {
        "name": "_getCenterCoordinate",
        "docblock": null,
        "modifiers": [],
        "params": [],
        "returns": null
      },
      {
        "name": "_packGeoJSON",
        "docblock": null,
        "modifiers": [],
        "params": [
          {
            "name": "geoJSON",
            "type": null
          }
        ],
        "returns": null
      }
    ],
    "props": {
      "animated": {
        "type": {
          "name": "bool"
        },
        "required": false,
        "description": "Animates changes between pitch and bearing",
        "defaultValue": {
          "value": "false",
          "computed": false
        }
      },
      "centerCoordinate": {
        "type": {
          "name": "arrayOf",
          "value": {
            "name": "number"
          }
        },
        "required": false,
        "description": "Initial center coordinate on map [lng, lat]"
      },
      "showUserLocation": {
        "type": {
          "name": "bool"
        },
        "required": false,
        "description": "Shows the users location on the map"
      },
      "userTrackingMode": {
        "type": {
          "name": "number"
        },
        "required": false,
        "description": "The mode used to track the user location on the map",
        "defaultValue": {
          "value": "MapboxGL.UserTrackingModes.None",
          "computed": true
        }
      },
      "heading": {
        "type": {
          "name": "number"
        },
        "required": false,
        "description": "Initial heading on map",
        "defaultValue": {
          "value": "0",
          "computed": false
        }
      },
      "pitch": {
        "type": {
          "name": "number"
        },
        "required": false,
        "description": "Initial pitch on map",
        "defaultValue": {
          "value": "0",
          "computed": false
        }
      },
      "style": {
        "type": {
          "name": "any"
        },
        "required": false,
        "description": "Style for wrapping React Native View"
      },
      "styleURL": {
        "type": {
          "name": "string"
        },
        "required": false,
        "description": "Style URL for map",
        "defaultValue": {
          "value": "MapboxGL.StyleURL.Street",
          "computed": true
        }
      },
      "zoomLevel": {
        "type": {
          "name": "number"
        },
        "required": false,
        "description": "Initial zoom level of map",
        "defaultValue": {
          "value": "16",
          "computed": false
        }
      },
      "minZoomLevel": {
        "type": {
          "name": "number"
        },
        "required": false,
        "description": "Min zoom level of map"
      },
      "maxZoomLevel": {
        "type": {
          "name": "number"
        },
        "required": false,
        "description": "Max zoom level of map"
      },
      "scrollEnabled": {
        "type": {
          "name": "bool"
        },
        "required": false,
        "description": "Enable/Disable scroll on the map",
        "defaultValue": {
          "value": "true",
          "computed": false
        }
      },
      "pitchEnabled": {
        "type": {
          "name": "bool"
        },
        "required": false,
        "description": "Enable/Disable pitch on map",
        "defaultValue": {
          "value": "true",
          "computed": false
        }
      },
      "onPress": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "Map press listener, gets called when a user presses the map"
      },
      "onLongPress": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "Map long press listener, gets called when a user long presses the map"
      },
      "onRegionWillChange": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered whenever the currently displayed map region is about to change."
      },
      "onRegionIsChanging": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered whenever the currently displayed map region is changing."
      },
      "onRegionDidChange": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered whenever the currently displayed map region finished changing"
      },
      "onWillStartLoadingMap": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when the map is about to start loading a new map style."
      },
      "onDidFinishLoadingMap": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This is triggered when the map has successfully loaded a new map style."
      },
      "onDidFailLoadingMap": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when the map has failed to load a new map style."
      },
      "onWillStartRenderingFrame": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when the map will start rendering a frame."
      },
      "onDidFinishRenderingFrame": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when the map finished rendering a frame."
      },
      "onDidFinishRenderingFrameFully": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when the map fully finished rendering a frame."
      },
      "onWillStartRenderingMap": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when the map will start rendering the map."
      },
      "onDidFinishRenderingMap": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when the map finished rendering the map."
      },
      "onDidFinishRenderingMapFully": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when the map fully finished rendering the map."
      },
      "onDidFinishLoadingStyle": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when a style has finished loading."
      },
      "onFlyToComplete": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when a fly to animation is cancelled or completed after calling flyTo"
      },
      "onSetCameraComplete": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered once the camera is finished after calling setCamera"
      },
      "onUserLocationChange": {
        "type": {
          "name": "func"
        },
        "required": false,
        "description": "This event is triggered when the users location changes depands on showUserLocation"
      }
    }
  }
}