fmtc_advanced library

Secondary advanced import point for 'flutter_map_tile_caching'

Checkout the README for more documentation.

Exports full API, including from internal files not exported by the recommended import package:flutter_map_tile_caching/flutter_map_tile_caching.dart

Classes

AndroidNotificationDetails
Contains notification details specific to Android.
AndroidResource
BaseRegion
A region that can be downloaded, drawn on a map, or converted to a list of points, that forms a particular shape
ChangeType
Enum for what kind of change has happened to a file.
CircleRegion
A circular region with a center point and a radius
Directory
A reference to a directory (or folder) on the file system.
DownloadableRegion
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
File
A reference to a file on the file system.
FilesystemSanitiserResult
Object to return from any filesystem sanitiser defined in FMTCSettings.filesystemSanitiser
FlutterMapTileCaching
Main singleton access point for 'flutter_map_tile_caching'
FMTCBackgroundDownload
A widget that enables correct functioning of the background download process/service
FMTCImageProvider
A specialised ImageProvider dedicated to 'flutter_map_tile_caching'
FMTCSettings
Global 'flutter_map_tile_caching' settings
FMTCTileProvider
'flutter_map_tile_caching's custom TileProvider for use in a TileLayer
FMTCTileProviderSettings
Settings for an FMTCTileProvider
InternalProgressTimingManagement
Internal class for managing the tiles per second (averageTPS) measurement of a download
LineRegion
A region with the border as the locus of a line at it's center
RecoveredRegion
A mixture between BaseRegion and DownloadableRegion containing all the salvaged data from a recovered download
RectangleRegion
A rectangular region with two or more corners
RootAccess
Provides direct filesystem access paths to a RootDirectory - use with caution
RootDirectory
Access point to a root
RootImport
Provides store import functionality for a RootDirectory
RootManagement
Manages a RootDirectory's representation on the filesystem, such as creation and deletion
RootRecovery
Manages the download recovery of all sub-stores of this RootDirectory
RootStats
Provides statistics about a RootDirectory
StoreAccess
Provides direct filesystem access paths to a StoreDirectory - use with caution
StoreDirectory
Access point to a store
StoreExport
Provides import and export functionality for a StoreDirectory
StoreManagement
Manages a StoreDirectory's representation on the filesystem, such as creation and deletion
StoreStats
Provides statistics about a StoreDirectory
TileProgress
TimestampProgress
Object containing the timestamp of the measurement and the percentage progress (0-1) of the applicable tile

Enums

CacheBehavior
Multiple behaviors dictating how browse caching should be carried out
RegionType
Describes what shape, and therefore rules, a DownloadableRegion conforms to
RootParts
Parts of the root cache which can be watched
StoreParts
Parts of a store which can be watched

Functions

bulkDownloader({required List<Coords<num>> tiles, required FMTCTileProvider provider, required TileLayer options, required Client client, required dynamic errorHandler(Object?)?, required int parallelThreads, required bool preventRedownload, required Uint8List? seaTileBytes, required Queue queue, required StreamController<TileProgress> streamController, required int downloadID, required InternalProgressTimingManagement progressManagement}) Stream<TileProgress>
circleTiles(Map<String, dynamic> input) List<Coords<num>>
decode(File file) Future<RecoveredRegion>
defaultFilesystemSanitiser(String input) FilesystemSanitiserResult
encode({required int id, required String storeName, required DownloadableRegion region, required RootDirectory rootDirectory}) Future<void>
filesystemSanitiseValidate({required String inputString, required bool throwIfInvalid}) String
lineTiles(Map<String, dynamic> input) List<Coords<num>>
rectangleTiles(Map<String, dynamic> input) List<Coords<num>>

Typedefs

FMTC = FlutterMapTileCaching
Direct alias of FlutterMapTileCaching for easier development

Exceptions / Errors

InvalidFilesystemString
An Exception thrown by FMTCSettings.filesystemSanitiser indicating that the supplied string was invalid