Skip to content

Latest commit

 

History

History
105 lines (93 loc) · 6.69 KB

API.md

File metadata and controls

105 lines (93 loc) · 6.69 KB
Raw

Android API Docs

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
scrollEnabled bool Optional true Whether the map can be scrolled
zoomEnabled bool Optional true Whether the map zoom level can be changed
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 streets-v8.
annotations array Optional NA An array of annotation objects. See annotation detail
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
attributionButtonIsHidden bool Optional false Whether attribution button is visible in lower left corner. If true you must still attribute OpenStreetMap in your app. Ref
logoIsHidden bool Optional false Whether logo is visible in lower left corner.
compassIsHidden bool Optional false Whether compass is visible when map is rotated.

Events

Event Name Returns Notes
onRegionChange {latitude: 0, longitude: 0, zoom: 0} Fired when the map is panning or zooming.
getCenterCoordinateZoomLevel mapViewRef, callback Gets the current center location and zoom level. Returns a single callback object.
getDirection mapViewRef, callback Gets the current direction. Returns a single callback object.
onOpenAnnotation {title: null, subtitle: null, latitude: 0, longitude: 0} Fired when focusing a an annotation. If the annotation is opened already, the event will not fire.
onLongPress {latitude: 0, longitude: 0} Fired when the user taps and holds the map.
getBounds mapViewRef, callback Returns current bounds for view (NE & SW).

Methods for Modifying the Map State

Each method also requires you to pass in a string as the first argument which is equal to the ref on the map view you wish to modify. See the example on how this is implemented.

Method Name Arguments Notes
setDirectionAnimated mapViewRef, heading Rotates the map to a new heading
setCenterCoordinateAnimated mapViewRef, latitude, longitude Moves the map to a new coordinate. Note, the zoom level stay at the current zoom level
setCenterCoordinateZoomLevelAnimated mapViewRef, latitude, longitude, zoomLevel Moves the map to a new coordinate and zoom level
addAnnotations mapViewRef, `` (array of annotation objects, see #annotations) Adds annotation(s) to the map without redrawing the map. Note, this will remove all previous annotations from the map.
removeAllAnnotations mapViewRef Removes all annotations on map.
setVisibleCoordinateBoundsAnimated mapViewRef, latitude1, longitude1, latitude2, longitude2, padding top, padding right, padding bottom, padding left Changes the viewport to fit the given coordinate bounds and some additional padding on each side.
setUserTrackingMode mapViewRef, NONE or FOLLOW Modifies the tracking mode.

GL Styles

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

  • mapbox://styles/dark-v8.json
  • mapbox://styles/light-v8.json
  • mapbox://styles/emerald-v8.json
  • mapbox://styles/streets-v8.json
  • mapbox://styles/satellite-v8.json

Annotations

[{
  "coordinates": "required. For type polyline and polygon must be an array of arrays. For type point, single array",
  "type": "required: point, polyline or polygon",
  "title": "optional string",
  "subtitle": "optional string",
  "fillAlpha": "optional, only used for type=polygon. Controls the opacity of polygon",
  "fillColor": "optional string hex color including #, only used for type=polygon*",
  "strokeAlpha": "optional number from 0-1. Only used for type=poyline. Controls opacity of line",
  "strokeColor": "optional string hex color including #, used for type=polygon and type=polyline*",
  "strokeWidth": "optional number. Only used for type=poyline. Controls line width",
  "id": "optional string, unique identifier.",
  "annotationImage": {
    "url": "Optional. Either remote image or specify via 'image!yourImage'",
    "height": "required if url specified",
    "width": "required if url specified"
  },
}]

*Valid colors can be seen here

Example

annotations: [{
  "coordinates": [40.72052634, -73.97686958312988],
  "type": "point",
  "title": "This is marker 1",
  "subtitle": "It has a rightCalloutAccessory too",
}, {
  "coordinates": [40.714541341726175,-74.00579452514648],
  "type": "point",
  "title": "Important",
  "subtitle": "Neat, this is a custom annotation image",
}, {
  "coordinates": [[40.76572150042782,-73.99429321289062],[40.743485405490695, -74.00218963623047],[40.728266950429735,-74.00218963623047],[40.728266950429735,-73.99154663085938],[40.73633186448861,-73.98983001708984],[40.74465591168391,-73.98914337158203],[40.749337730454826,-73.9870834350586]],
  "type": "polyline",
  "strokeColor": "#00FB00",
  "strokeWidth": 3,
  "strokeAlpha": 0.5
}, {
  "coordinates": [[40.749857912194386, -73.96820068359375], [40.741924698522055,-73.9735221862793], [40.735681504432264,-73.97523880004883], [40.7315190495212,-73.97438049316406], [40.729177554196376,-73.97180557250975], [40.72345355209305,-73.97438049316406], [40.719290332250544,-73.97455215454102], [40.71369559554873,-73.97729873657227], [40.71200407096382,-73.97850036621094], [40.71031250340588,-73.98691177368163], [40.71031250340588,-73.99154663085938]],
  "type": "polygon",
  "fillAlpha":1,
  "fillColor": "#C32C2C",
  "strokeColor": "#DDDDD"
}]