FlutterMapTileCaching.initialise constructor

FlutterMapTileCaching.initialise(
  1. RootDirectory rootDir, {
  2. FMTCSettings? settings,
})

Initialise the main singleton access point for 'flutter_map_tile_caching'

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

This returns the same object as FlutterMapTileCaching.instance will afterward. FMTC is an alias for this object.

Implementation

FlutterMapTileCaching.initialise(
  RootDirectory rootDir, {
  FMTCSettings? settings,
}) : settings = settings ?? FMTCSettings() {
  if (!rootDir.manage.ready) {
    throw StateError(
      'Supplied root directory does not exist. Try constructing it again, or using `rootDirectory.manage.create()`.',
    );
  }
  rootDirectory = rootDir;
  _instance = this;
}