Upgrade from version 0.1.x
Version 0.2.0 introduced some breaking changes. This site will guide you
through all of them.
General Information on Breaking Changes
We are using
the pub.dev version convention
for the package. While the package is prior its 1.0.0 release, the following
rules apply:
- Every minor
0.x.0release can introduce breaking changes. - Every increase of the patch value
0.0.xadds new features and functionality. - Every increase of 0.0.1+x indicates changes that don't affect the public API like bug fixes.
Step-by-Step guide
1. Compatible Flutter Version
Version 0.2.0 increased the minimum allowed version of Flutter
to 3.24.
Run flutter upgrade to upgrade Flutter.
2. Name Changes
Some properties and class names have changed. Replace the old with the new names.
| Old Name | New Name |
|---|---|
| MapZoomButtons | MapControlButtons |
| CircleLayer | CircleStyleLayer |
| FillExtrusionLayer | FillExtrusionStyleLayer |
| FillLayer | FillStyleLayer |
| HeatmapLayer | HeatmapStyleLayer |
| HillshadeLayer | HillshadeStyleLayer |
| LineLayer | LineStyleLayer |
| RasterLayer | RasterStyleLayer |
| SymbolLayer | SymbolStyleLayer |
| CircleAnnotationLayer | CircleLayer |
| MarkerAnnotationLayer | MarkerLayer |
| PolygonAnnotationLayer | PolygonLayer |
| PolylineAnnotationLayer | PolylineLayer |
3. Programmatic Style Control
Style related functionality is now loaded in the new StyleController.
For an easy migration, you can access it using the
nullable mapController.style getter.
The onStyleLoaded callback now returns the StyleController of the loaded
style: onStyleLoaded: (style) { ... }
4. Update your web integration
maplibre 0.2.0
uses MapLibre GL JS version 5.0.0
onwards. Open your web/index.html file and update the used library version.
<!DOCTYPE html>
<html>
<head>
<!-- other html -->
<script src='https://unpkg.com/maplibre-gl@^5.0/dist/maplibre-gl.js'></script>
<link href='https://unpkg.com/maplibre-gl@^5.0/dist/maplibre-gl.css'
rel='stylesheet'/>
</head>
</html>