Skip To Content ArcGIS for Developers Sign In Dashboard

TileCache Class


A tile cache persisted on a device. More...

Header: #include <TileCache>
Since: Esri::ArcGISRuntime 100.0
Inherits: Object and Loadable

Public Functions

TileCache(const QString &path, QObject *parent = nullptr)
CacheStorageFormat cacheStorageFormat() const
Envelope fullExtent() const
bool isAntialiasing() const
QString path() const
QImage thumbnail() const
TileInfo tileInfo() const

Reimplemented Public Functions

virtual void cancelLoad()
virtual void load()
virtual Error loadError() const
virtual LoadStatus loadStatus() const
virtual void retryLoad()


void doneLoading(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

A tile cache persisted on a device.

The TileCache is persisted as either a tile cache folder or a tile package (*.TPK) file on the device's file system.

Member Function Documentation

TileCache::TileCache(const QString &path, QObject *parent = nullptr)

Constructor that takes a path to a local tile cache and an optional parent.



CacheStorageFormat TileCache::cacheStorageFormat() const

Returns the cache storage format of this tile cache.

This function was introduced in Esri::ArcGISRuntime 100.2.

[virtual] void TileCache::cancelLoad()

Reimplemented from Loadable::cancelLoad().

See Loadable.

[signal] void TileCache::doneLoading(Esri::ArcGISRuntime::Error loadError)

Signal emitted when this object is done loading.

  • loadError - Details about any error that may have occurred.

Note: If there is a load error it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

Envelope TileCache::fullExtent() const

Returns the full extent as an Envelope.

Expressed in coordinates of the spatial reference of the source map document.

bool TileCache::isAntialiasing() const

Returns the antialiasing flag of this tile cache.

[virtual] void TileCache::load()

Reimplemented from Loadable::load().

See Loadable.

[virtual] Error TileCache::loadError() const

Reimplemented from Loadable::loadError().

See Loadable.

[virtual] LoadStatus TileCache::loadStatus() const

Reimplemented from Loadable::loadStatus().

See Loadable.

[signal] void TileCache::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

loadStatus See Loadable.

QString TileCache::path() const

Returns the path to the local tile cache or tile package this TileCache is referencing.

[virtual] void TileCache::retryLoad()

Reimplemented from Loadable::retryLoad().

See Loadable.

QImage TileCache::thumbnail() const

Gets the thumbnail image of this tile cache.

TileInfo TileCache::tileInfo() const

Returns tile info from the local tile cache.

This is only available after the TileCache is loaded.

See also Loadable.

Feedback on this topic?