Skip To Content ArcGIS for Developers Sign In Dashboard

TileCache QML Type

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

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Methods

Detailed Description

Functional characteristics

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, thereby creating a tile package (.tpk/.tpkx). Alternatively, you can use ArcGIS Pro to create a map tile package and provision it to the device. 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 less frequently changing contextual layers, where network access is limited or non-existent. They can be created and downloaded onto a device by using an ExportTileCacheJob, or alternatively can be provisioned directly to local storage. The supported types of cache 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 TileCache 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.

See also Loadable and ArcGISTiledLayer.

Property Documentation

antialiasing : bool

Returns the antialiasing flag of this tile cache (read-only).


cacheStorageFormat : Enums.CacheStorageFormat

Returns the cache storage format of this tile cache (read-only).

This property was introduced in Esri.ArcGISRuntime 100.2.

See also Enums.CacheStorageFormat.


fullExtent : Envelope

Returns the full geometric extent as an Envelope (read-only).

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


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.


loadStatus : Enums.LoadStatus


path : url

The path to the local tile cache this TileCache is referencing.

This is the file system path to the local tile cache or tile package.


thumbnailUrl : url

Returns the URL of the thumbnail image of this tile cache (read-only).


tileInfo : TileInfo

Returns tile info from the local tile cache (read-only).

This is only available after the TileCache is loaded.


Signal Documentation

antialiasingChanged()

Emitted when the antialiasing property changes.

Note: The corresponding handler is onAntialiasingChanged.

See also Loadable.


cacheStorageFormatChanged()

Emitted when the cacheStorageFormat property changes.

Note: The corresponding handler is onCacheStorageFormatChanged.

This signal was introduced in Esri.ArcGISRuntime 100.2.

See also Loadable.


fullExtentChanged()

Emitted when the fullExtent property changes.

Note: The corresponding handler is onFullExtentChanged.

See also Loadable.


loadErrorChanged()

Emitted when the loadError property of this TileCache changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.


pathChanged()

Emitted when the path property changes.

Note: The corresponding handler is onPathChanged.


thumbnailUrlChanged()

Emitted when the thumbnailUrl property changes.

Note: The corresponding handler is onThumbnailUrlChanged.

See also Loadable.


tileInfoChanged()

Emitted when the tileInfo property changes.

Note: The corresponding handler is onTileInfoChanged.


Method Documentation

void cancelLoad()

See also Loadable.


void load()

See also Loadable.


void retryLoad()

See also Loadable.



Feedback on this topic?