flutter_map_tile_caching library
A plugin for 'flutter_map' providing advanced offline functionality
Classes
- BaseRegion
- A geographical region that forms a particular shape
- CircleRegion
- A geographically circular region based off a center coord and radius
- CustomPolygonRegion
- A geographical region who's outline is defined by a list of coordinates
-
DownloadableRegion<
R extends BaseRegion> - A downloadable region to be passed to bulk download functions
- DownloadProgress
- Statistics and information about the current progress of the download
- FMTCBackend
- An abstract interface that FMTC will use to communicate with a storage 'backend' (usually one root)
- FMTCBackendInternal
- An abstract interface that FMTC will use to communicate with a storage 'backend' (usually one root), from a 'normal' thread (likely the UI thread)
- FMTCBackendInternalThreadSafe
- An abstract interface that FMTC will use to communicate with a storage 'backend' (usually one root), from an existing bulk downloading thread
- FMTCObjectBoxBackend
- Implementation of FMTCBackend that uses ObjectBox as the storage database
- FMTCObjectBoxBackendInternal
- Internal implementation of FMTCBackend that uses ObjectBox as the storage database
- FMTCRoot
- Provides access to statistics, recovery, migration (and the import functionality) on the intitialised root.
- FMTCStore
- Provides access to management, statistics, metadata, bulk download, the tile provider (and the export functionality) on the store named storeName
- FMTCTileProvider
-
Specialised
TileProviderthat uses a specialised ImageProvider to connect to FMTC internals - 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
- RootExternal
- Export & import 'archives' of selected stores and tiles, outside of the FMTC environment
- RootRecovery
- Manages the download recovery of all sub-stores of this FMTCRoot
- RootStats
- Provides statistics about a FMTCRoot
- StoreDownload
- Provides bulk downloading functionality for a specific FMTCStore
- StoreManagement
- Manages an FMTCStore's representation on the filesystem, such as creation and deletion
- StoreMetadata
- Manage custom miscellaneous information tied to an FMTCStore
- StoreStats
- Provides statistics about an FMTCStore
- TileEvent
- The raw result of a tile download during bulk downloading
Enums
- CacheBehavior
- Behaviours dictating how and when browse caching should occur
- FMTCBrowsingErrorType
- Defines the type of issue that a FMTCBrowsingError is reporting
- ImportConflictStrategy
- Determines what action should be taken when an importing store conflicts with an existing store of the same name
- TileEventResult
- The result of attempting to cache the associated tile/TileEvent
- TileEventResultCategory
- A generalized category for TileEventResult
Extensions
-
FMTCRecoveryGetFailedExts
on Iterable<
({bool isFailed, RecoveredRegion region})> - Contains failedOnly extension for RootRecovery.recoverableRegions
- RootRecoveryDeprecations on RootRecovery
- Provides deprecations where possible for previous methods in RootRecovery after the v9 release.
- RootStatsDeprecations on RootStats
- Provides deprecations where possible for previous methods in RootStats after the v9 release.
- StoreManagementDeprecations on StoreManagement
- Provides deprecations where possible for previous methods in StoreManagement after the v9 release.
- StoreMetadataDeprecations on StoreMetadata
- Provides deprecations where possible for previous methods in StoreMetadata after the v9 release.
- StoreStatsDeprecations on StoreStats
- Provides deprecations where possible for previous methods in StoreStats after the v9 release.
Typedefs
- FMTCBrowsingErrorHandler = void Function(FMTCBrowsingError exception)
- Callback type that takes an FMTCBrowsingError exception
-
ImportResult
= ({Future<
int> complete, Future<StoresToStates> storesToStates}) - The result of RootExternal.import
- RootDirectory = FMTCRoot
- Equivalent to FMTCRoot, provided to ease migration only
- StoreDirectory = FMTCStore
- Equivalent to FMTCStore, provided to ease migration only
-
StoresToStates
= Map<
String, ({bool hadConflict, String? name})> - A mapping of the original store name (as exported), to:
Exceptions / Errors
- ExportInRootDirectoryForbidden
- Indicates that an export failed because the specified output path directory was the same as the root directory
- FMTCBackendError
- An error to be thrown by backend implementations in known events only
- FMTCBrowsingError
- An Exception indicating that there was an error retrieving tiles to be displayed on the map
- FMTCObjectBoxBackendError
- An FMTCBackendError that originates specifically from the FMTCObjectBoxBackend
- ImportExportError
- A subset of FMTCBackendErrors that indicates a failure during import or export, due to the extended reason
- ImportExportPathNotFile
- Indicates that the specified path to import from or export to did exist, but was not a file
- ImportFileNotBackendCompatible
- Indicates that the import file was exported from a different FMTC backend, and is not compatible with the current backend
- ImportFileNotFMTCStandard
- Indicates that the import file was not of the expected standard, because it did not contain the appropriate footer signature
- ImportPathNotExists
- Indicates that the specified file to import did not exist/could not be found
- RootAlreadyInitialised
- Indicates that the backend/root structure could not be initialised, because it was already initialised
- Indicates that the backend/root structure (ie. database and/or directory) was not available for use in operations, because either:
- StorageException
- ObjectBox database exception with an OBX_ERROR code.
- StoreNotExists
- Indicates that the specified store structure was not available for use in operations, likely because it didn't exist