flutter_map Integration

Stores also have the method getTileProvider(). This is the point of integration with flutter_map, providing browse caching through a custom image provider, and can be used as so:

import 'package:flutter_map/flutter_map.dart';

TileLayer(
    tileProvider: FMTC.instance('storeName').getTileProvider(),
),

Tile Provider Settings

This method (and others) optionally take a FMTCTileProviderSettings. These configure the behaviour of the tile provider. Defaults to Default Tile Provider Settings (defaultTileProviderSettings), or the package default (see table below) if that is not specified.

FMTCTileProviderSettings can take the following arguments:

behavior: CacheBehavior

Determine the logic used during handling storage and retrieval of browse caching

CacheBehavior.cacheFirst

cachedValidDuration: Duration

Length of time a tile remains valid, after which it must be fetched again (ignored in onlineFirst mode)

const Duration(days: 16)

maxStoreLength: int

Maximum number of tiles allowed in a cache store (deletes oldest tile)

0: disabled

Note that using maxStoreLength can have a negative effect on performance, as sorting the tiles to find the oldest is (currently) expensive.

Cache Behavior

This enumerable contains 3 values, which are used to dictate which logic should be used to store and retrieve tiles from the store.

Value	Explanation
cacheFirst	Get tiles from the local cache if possible. Only uses the Internet if it doesn't exist, or to update it if it has expired.
onlineFirst	Get tiles from the Internet if possible. Updates every cached tile every time it is fetched (ignores expiry).
cacheOnly	Only get tiles from the local cache, and throw an error if not found. Recommended for dedicated offline modes.

Check If A Tile Is Cached

The object returned by this function also has the method checkTileCached, with the following parameters:

FMTC.instance('storeName').getTileProvider().checkTileCached(
    coords: Coords<num>,
    options: TileLayer,
    customUrl: String?,
 )

Pass the coords of the tile to check for, and the same/similar TileLayer used to store the tile in the first place.

It will return a boolean dependent on whether or not the tile could be found.