migrate-to-maplibre.md

jupyter

jupytext kernelspec language_info plotly notebook_metadata_filter text_representation all extension format_name format_version jupytext_version .md markdown 1.3 1.16.1 display_name language name Python 3 (ipykernel) python python3 codemirror_mode file_extension mimetype name nbconvert_exporter pygments_lexer version name version ipython 3 .py text/x-python python python ipython3 3.10.11 description display_as language layout name order page_type permalink redirect_from thumbnail Migrating from Mapbox traces to MapLibre traces. maps python base MapLibre Migration 1 u-guide python/mapbox-to-maplibre/ python/maplibre-migration/ thumbnail/mapbox-layers.png

Migrating from Mapbox traces to MapLibre traces

With the release of Plotly.py v5.24.0, we are introducing a new set of trace types for maps with tile underlays, including from Plotly Express:

• px.scatter_map
• px.line_map
• px.choropleth_map
• px.density_map

as well as Plotly Graph Objects:

• go.Choroplethmap
• go.Scattermap
• go.Densitymap

These traces replace the existing Mapbox traces, px.scatter_mapbox, px.line_mapbox, etc., but use MapLibre as the map renderer rather than Mapbox.

When switching to the new traces, keep an eye out for improved rendering performance, WebGL2 support, and over time, improved features in the Plotly map traces inherited from the MapLibre renderer, including projection support, globe views, terrain support, and support for modern mapping standards.

You can learn more about the motivations for this change in our announcement post.

As a result of removing Mapbox as the rendering engine, we're also removing the Mapbox branding from these trace names. This means that migrating from Mapbox traces to MapLibre traces will require some code changes in your projects.

1. Change trace names from *mapbox to *map. For any existing trace name ending in *mapbox, ensure you've removed the "box" suffix.
2. If in use, update layout.mapbox argument in your layout configuration to layout.map. The nested properties are identical in the new map traces, so no other changes should be required.
3. If in use, update mapbox_style to map_style.
4. Verify your map_style settings. With mapbox traces, we bundle basic, streets, outdoors, light, dark, satellite, and satellite-streets styles, using Mapbox styling. These style names are still available, but they now reference slightly different styles provided by other tools.

Note that Mapbox API keys are no longer required for Plotly-provided styles, but using external styles in your Plotly maps remains supported with the existing API.

Style changes

Built-in styles in map traces are free styles from Carto and ESRI. Several names are re-used from the previous Mapbox styles.

Compare to the previous Mapbox styles: