Offline Mapping
Last updated
Last updated
© flutter_map Authors & Maintainers
Using maps without an Internet connection is common requirement. Luckily, there are a few options available to you to implement offline mapping in your app.
Caching Automatically store tiles as the user loads them through interacting with the map
Bulk downloading Download an entire area/region of tiles in one shot, ready for a known no-Internet situation
Bundling Provide a set of tiles to all users through assets or the filesystem
There's 3 methods that basic caching can be implemented in your app, two of which rely on community maintained plugins:
flutter_map_cache (lightweight and MIT licensed)
flutter_map_tile_caching (also includes Bulk Downloading, but GPL licensed)
Custom implementation, via a custom TileProvider and ImageProvider (either custom or via a package such as cached_network_image)
When it comes to bulk downloading, this is much more complex than Caching, especially for regions that are a non-rectangular shape. Implementing this can be very time consuming and prone to issues.
The community maintained plugin 'flutter_map_tile_caching' includes advanced bulk downloading functionality, of multiple different region shapes, and other functionality. It is however GPL licensed. To help choose whether FMTC or DIY is more appropriate for your use case, please see:
If you have a set of custom raster tiles that you need to provide to all your users, you may want to consider bundling them together, to make a them easier to deploy to your users.
There is essentially two options for doing this:
Using AssetTileProvider, you can bundle a set of map tiles and register them as an asset within your app's pubspec.yaml. This means that they will be downloaded together with your application, keeping setup simple, but at the expense of a larger application bundle size.
Using FileTileProvider, you can bundle a set of map tiles and store them on a remote web server, that can be downloaded from later. This means that the setup may be more complicated for users, but the application's bundle size will be much smaller.
Either way, the filesystem should be structured like this: 'offlineMap/{z}/{x}/{y}.png', where every .png image is a tile.
If you have a raster-format .mbtiles file, for example from TileMill, you should use mbtilesToPngs to convert it to the correct structure first. Alternatively, you can use an external package such as 'flutter_mbtiles_extractor' to extract during runtime.
