Introduction

This package provides the ability to download areas of maps, known as regions throughout this documentation.

After downloading, tiles are stored in the same place as when Browse Caching, meaning that no extra setup is needed to use them in a map (other than the usual integration)!

Before continuing with usage, make ensure you comply with the appropriate rules and terms of service set by your tile server.

OpenStreetMap's can be found here: specifically bulk downloading is discouraged, and forbidden after zoom level 13. Other servers may have different terms.

This library and/or the creator(s) are not responsible for any violations you make using this package. Remember that this library automatically adds a clear 'with flutter_map_tile_caching' to the User-Agent header.

4 Steps To Downloading

1. Create a region based on the user's input

2. Convert that region into a downloadable region

3. Start downloading that region, either in the foreground or background

4. Listen for progress events to update your user

Available APIs

All APIs listed in this section are children of the download getter.

API Member	Explanation
startForeground()	Start a download in the foreground
startBackground()	Start a download in the background
check()	Check the number of tiles in a certain region
cancel()	Cancel any ongoing downloads

Recovery

The recovery system is designed to support bulk downloading, and provide some form of recovery if the download fails unexpectedly - this might happen if the app crashes, for example.

Read more about the recovery system here:

pageRecovery