FlutterMapTileCaching class

Main singleton access point for 'flutter_map_tile_caching'

You must construct using FlutterMapTileCaching.initialise before using FlutterMapTileCaching.instance, otherwise a StateError will be thrown. Note that the singleton can be re-initialised/changed by calling the aforementioned constructor again.

FMTC is an alias for this object.

Properties

debugMode bool
Whether FMTC should perform extra reporting and console logging
no setter
hashCode int
The hash code for this object.
no setterinherited
rootDirectory RootDirectory
The directory which contains all databases required to use FMTC
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
settings FMTCSettings
Custom global 'flutter_map_tile_caching' settings
final

Methods

call(String storeName) StoreDirectory
Get a StoreDirectory by name, without creating it automatically
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited
operator [](String storeName) StoreDirectory
Get a StoreDirectory by name, and create it synchronously automatically

Static Properties

instance FlutterMapTileCaching
Get the configured instance of FlutterMapTileCaching, after FlutterMapTileCaching.initialise has been called, for further actions
no setter

Static Methods

initialise({String? rootDirectory, FMTCSettings? settings, void errorHandler(FMTCInitialisationException error)?, bool disableInitialisationSafety = false, bool debugMode = false}) Future<FlutterMapTileCaching>
Initialise and prepare FMTC, by creating all neccessary directories/files and configuring the FlutterMapTileCaching singleton