Upgrade from version 0.0.x
Version 0.1.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.
By setting ^0.1.0 in your pubspec.yaml file pub will automatically resolve a
compatible package version but won't use the next breaking release 0.2.0.
Step-by-Step guide
1. Compatible Flutter Version
Version 0.1.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 |
|---|---|
| controller.jumpTo() | controller.moveCamera() |
| controller.flyTo() | controller.animateCamera() |
| MapOptions(controls: ) | MapOptions(webControls: ) |
| MapOptions(style: ) | MapOptions(initStyle: ) |
| MapOptions(zoom: ) | MapOptions(initZoom: ) |
| MapOptions(center: ) | MapOptions(initCenter: ) |
| MapOptions(bearing: ) | MapOptions(initBearing: ) |
| MapControl() | WebMapControl() |
| ScaleControl() | WebScaleControl() |
| LogoControl() | WebLogoControl() |
| GeolocateControl() | WebGeolocateControl() |
| FullscreenControl() | WebFullscreenControl() |
| NavigationControl() | WebNavigationControl() |
| mapCamera.tilt | mapCamera.pitch |
3. Use the event system
Callbacks have been replaced by Events that get emitted by the Map. Check out the Map Events documentation to see how you can use them.
| Old Callback Name | New Event Class |
|---|---|
| onClick | MapEventClick |
| onDoubleClick | MapEventDoubleClick |
| onSecondaryClick | MapEventSecondaryClick |
| onLongClick | MapEventLongClick |
4. Removed functionality
It is currently not possible to await the end of controller.animateCamera()
because of deadlock issues with callbacks in jni.
In the meantime, you have to rely on MapEventCameraIdle to detect once
animation is finished.