flutter_map_tile_caching library
A plugin for flutter_map providing advanced caching functionality, with ability to download map regions for offline use. Also includes useful prebuilt widgets.
Classes
- BaseRegion
- A geographical region that forms a particular shape
- CircleRegion
- A geographically circular region based off a center coord and radius
-
DownloadableRegion<
P extends List< Object> > - A downloadable region to be passed to bulk download functions
- DownloadManagement
- Provides tools to manage bulk downloading to a specific StoreDirectory
- DownloadProgress
- Represents the progress of an ongoing or finished (if percentageProgress is 100%) bulk download
- FlutterMapTileCaching
- Main singleton access point for 'flutter_map_tile_caching'
- FMTCSettings
- Global FMTC settings
- FMTCTileProvider
-
FMTC's custom
TileProviderfor use in aTileLayer - FMTCTileProviderSettings
- Settings for an FMTCTileProvider
- LineRegion
- A geographically line/locus region based off a list of coords and a radius
- RecoveredRegion
- A mixture between BaseRegion and DownloadableRegion containing all the salvaged data from a recovered download
- RectangleRegion
- A geographically rectangular region based off coordinate bounds
- RootDirectory
- Represents the root directory and root databases
- RootImport
- Extension access point for the 'fmtc_plus_sharing' module to add store export functionality
- RootManagement
- Manages a RootDirectory's representation on the filesystem, such as creation and deletion
- RootMigrator
- Manage migration for file structure across FMTC versions
- RootRecovery
- Manages the download recovery of all sub-stores of this RootDirectory
- RootStats
- Provides statistics about a RootDirectory
- StoreDirectory
- Represents a store of tiles
- StoreExport
- Extension access point for the 'fmtc_plus_sharing' module to add store export functionality
- StoreManagement
- Manages a StoreDirectory's representation on the filesystem, such as creation and deletion
- StoreMetadata
- Manage custom miscellaneous information tied to a StoreDirectory
- StoreStats
- Provides statistics about a StoreDirectory
Enums
- CacheBehavior
- Behaviours dictating how and when browse caching should be carried out
- DownloadBufferMode
- Describes the buffering mode during a bulk download
- FMTCBrowsingErrorType
- Pragmatic error descriptor for a FMTCBrowsingError.message
- FMTCDamagedStoreExceptionType
- Pragmatic error descriptor for a FMTCDamagedStoreException.message
- FMTCInitialisationExceptionType
- Pragmatic error descriptor for a FMTCInitialisationException.message
- RegionType
- Describes what shape, and therefore rules, a DownloadableRegion conforms to
- StoreParts
- Parts of a store which can be watched
Typedefs
- DatabaseCompactCondition = CompactCondition
-
See FMTCSettings.databaseCompactCondition and
CompactCondition's documentation for more information - FMTC = FlutterMapTileCaching
- Direct alias of FlutterMapTileCaching for easier development
Exceptions / Errors
- FMTCBrowsingError
- An Exception indicating that there was an error retrieving tiles to be displayed on the map
- FMTCDamagedStoreException
- An Exception indicating that an operation was attempted on a damaged store
- FMTCInitialisationException
- An Exception raised when FMTC failed to initialise a store
- FMTCStoreNotReady
- An Error indicating that a store did not exist when it was expected to