# Using Mapbox

{% hint style="info" %}
'flutter\_map' is in no way associated or related with Mapbox.

Mapbox's Maps home page: [mapbox.com/maps](https://www.mapbox.com/maps)\
Mapbox's Maps pricing page: [mapbox.com/pricing#maps](https://www.mapbox.com/pricing#maps)\
Mapbox's Maps documentation: [docs.mapbox.com/api/maps/static-tiles](https://docs.mapbox.com/api/maps/static-tiles)
{% endhint %}

{% hint style="warning" %}
Tile providers that also provide their own SDK solution to display tiles will often charge a higher price to use 3rd party libraries like flutter\_map to display their tiles. Just another reason to switch to an alternative provider.
{% endhint %}

To display their map tiles, Mapbox usually provides a 'Style URL' for map styles. However, to integrate with 3rd-party APIs, they also provide a 'CARTO Integration URL', and tiles requested through this endpoint consume the 'Static Tiles API' quota. This URL needs no extra configuration to integrate with flutter\_map.

## Integration

### Custom Styles

Mapbox supports creating and using custom styled maps through Studio.

{% hint style="warning" %}
Before attempting to use your style, ensure it actually has layers, and not just a Basemap, which will not appear in the tiles. The image below shows a style which will not work. If you only see blank tiles, but no errors, this is likely the cause.

To create a new style based on the Standard style, choose a template when creating the new style.

<img src="https://content.gitbook.com/content/SFuYRJZsfLx0EidjdMud/blobs/J0silSyz9cZPRSzPnhAZ/image.png" alt="" data-size="original"> &#x20;
{% endhint %}

1. Create a custom style using the editor
2. Click "Share...", or the share icon
3. Choose between Draft or Production
4. Scroll to the bottom of the dialog, and choose Third Party
5. Select "CARTO" from the dropdown menu
6. Click the copy button to copy the template URL, then paste it into your `TileLayer`

<figure><img src="https://content.gitbook.com/content/SFuYRJZsfLx0EidjdMud/blobs/2ya2YiFWgexX56Yd5W7t/Tile%20Provider%20Integration%20-%20Mapbox" alt="" width="563"><figcaption></figcaption></figure>

#### Configuring [Retina Mode](https://docs.fleaflet.dev/layers/tile-layer#retina-mode)

The URL includes an '@2x' string, which forces usage of high-definition tiles on all displays, without extra setup.

Should you need to let flutter\_map interfere, and only use retina tiles on retina/high-density displays, replace it with the '{r}' placeholder, then see [#retina-mode](https://docs.fleaflet.dev/layers/tile-layer#retina-mode "mention") for more information.

#### Other configurations

The maximum zoom level that Mapbox supports is 22, so it is recommended to set `maxNativeZoom` or `maxZoom` as such.

#### Adding Attribution

{% hint style="warning" %}
Attribution is required, and quite extensive compared to some alternatives: see [docs.mapbox.com/help/getting-started/attribution](https://docs.mapbox.com/help/getting-started/attribution/).

Consider using the [#richattributionwidget](https://docs.fleaflet.dev/layers/attribution-layer#richattributionwidget "mention"), which meets the requirements by supporting both logo and text attribution.
{% endhint %}

### Prebuilt Styles

Mapbox offers a variety of ready-made map styles that don't require customization. An example URL can be found in [the example here](https://docs.mapbox.com/api/maps/static-tiles/#example-request-retrieve-raster-tiles-from-styles).

This URL should be used as above, although you may need to insert the placeholders manually.