Files
react-native-mapbox-gl/API.md
T
2015-05-23 21:21:32 -07:00

2.1 KiB

Options

Option Type Opt/Required Default Note
accessToken string Required NA Mapbox access token. Sign up for a Mapbox account here.
centerCoordinate object Optional 0,0 Initial latitude/longitude the map will load at, defaults to 0,0.
zoomLevel double Optional 0 Initial zoom level the map will load at. 0 is the entire world, 18 is rooftop level. Defaults to 0.
rotateEnabled bool Optional true Whether the map can rotate
showsUserLocation bool Optional false Whether the user's location is shown on the map. Note - the map will not zoom to their location.
styleURL string Optional Mapbox Streets A Mapbox GL style sheet. Defaults to mapbox-streets. More styles can be viewed here.
annotations array Optional NA An array of annotation objects. latitude/longitude are required, both title and subtitle are optional.
direction double Optional 0 Heading of the map in degrees where 0 is north and 180 is south
debugActive bool Optional false Turns on debug mode.
style flexbox view Optional NA Styles the actual map view container

GL Styles

You can change the styleURL to any valid GL stylesheet, here are a few:

  • asset://styles/basic-v7.json
  • asset://styles/bright-v7.json
  • asset://styles/dark-v7.json
  • asset://styles/emerald-v7.json
  • asset://styles/light-v7.json
  • asset://styles/mapbox-streets-v7.json
  • asset://styles/outdoors-v7.json
  • asset://styles/satellite-v7.json

Events

Event Name Returns Notes
onRegionChange {latitude: 0, longitude: 0, zoom: 0} Triggered by panning or zooming the map.
onOpenAnnotation {title: null, subtitle: null, latitude: 0, longitude: 0} Fired when focusing a an annotation.
onUpdateUserLocation {latitude: 0, longitude: 0, headingAccuracy: 0, magneticHeading: 0, trueHeading: 0, isUpdating: false} Fired when the users location updates.