TileCache class final

A local cache of rendered map tiles that can be used to create a layer.

A tile cache stores a collection of images at various scales. A client can request the tiles needed to display a particular map extent. You can use ExportTileCacheTask to generate and download tiles from a service, creating a tile package (.tpk/.tpkx). Alternatively, you can use ArcGIS Pro to create a map tile package and provision it to the device.

Functional characteristics

ArcGIS tiled layers do not support reprojection, query, select, identify, or editing.

Performance characteristics

Tiles are generated when the cache is created. Requests for tiles are made on multiple threads and handled asynchronously. The size of each returned tile increases as the resolution or complexity of the image in the tile increases. For example, high-resolution imagery tiles can be larger files than topographic mapping for the same area and map extent.

Local tile caches are ideal for providing basemaps, or for infrequent changes to contextual layers when network access is limited or non-existent. Use ExportTileCacheJob to create and download a local tile cache to a device. Alternatively, the cache can be provisioned directly to local storage. The supported types of cache file formats are:

  • Tile package (.tpk, .tpkx) - a tile cache of data, packaged into one convenient, portable file, ideal for offline sharing of complete tiled layers in a disconnected environment or via a portal.
  • Compact Cache - a directory structure where groups of tiles are combined into larger .bundle files, preserving performance and reducing copy times and the size on disk of the cache.
  • Exploded Cache - a directory structure where map tiles are stored as individual files.

A tile cache is often used as a basemap, but can also be used to create an ArcGISTiledLayer that is added to a map as an operational layer. An offline ArcGISTiledElevationSource can also be created from an appropriate tile cache and added to the Scene.baseSurface of an ArcGISScene.

Implemented types
Mixed in types

Constructors

TileCache.withFileUri(Uri fileUri)
Create a tile cache from the specified tile cache path.
factory

Properties

antialiasing bool
The antialiasing flag of this tile cache.
no setter
cacheStorageFormat CacheStorageFormat
The storage format of this tile cache.
no setter
fileUri Uri?
The path of the tile cache.
no setter
fullExtent Envelope?
The full extent of the tile cache.
no setter
hashCode int
The hash code for this object.
no setteroverride
loadError ArcGISException?
The load error.
no setterinherited
loadStatus LoadStatus
The load status.
no setterinherited
onLoadStatusChanged Stream<LoadStatus>
A stream that reports changes to the LoadStatus.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
thumbnail ArcGISImage?
The thumbnail image of this tile cache.
no setter
tileInfo TileInfo?
Information about the tiling scheme used by this tile cache.
no setter

Methods

cancelLoad() → void
Cancels loading metadata for the object.
inherited
clone() TileCache
Clones the TileCache.
getTileData({required TileKey tileKey}) Uint8List?
Returns the tile data for the specified tile key.
load() Future<void>
Loads the metadata for the object asynchronously.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
retryLoad() Future<void>
Loads or retries loading metadata for the object asynchronously.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
override