TileCache QML Type

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

    Import Statement: import Esri.ArcGISRuntime
    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 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 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. An offline ArcGISTiledElevationSource can also be created from an appropriate tile cache and added to the Scene::baseSurface of a Scene.

    See also Loadable and ArcGISTiledLayer.

    Property Documentation

    [read-only] antialiasing : bool

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


    [read-only, since Esri.ArcGISRuntime 100.2] 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.


    [read-only] fullExtent : Envelope

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

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


    [read-only] 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.


    [read-only] 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.


    [read-only] thumbnailUrl : url

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


    [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.


    [since Esri.ArcGISRuntime 100.2] 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.


    [since Esri.ArcGISRuntime 200.1] TileCache clone()

    Creates a deep copy of this object.

    This method was introduced in Esri.ArcGISRuntime 200.1.


    [since Esri.ArcGISRuntime 200.1] bool equals(TileCache other)

    Compares two TileCaches for equality.

    Returns whether this instance and other are equivalent.

    This method was introduced in Esri.ArcGISRuntime 200.1.


    void load()

    See also Loadable.


    void retryLoad()

    See also Loadable.


    [since Esri.ArcGISRuntime 100.14] ArrayBuffer tileData(int level, int column, int row)

    Returns the tile data for the specified tile key's level, column, and row.

    • level - The tile key's level.
    • column - The tile key's column.
    • row - The tile key's row.

    This method was introduced in Esri.ArcGISRuntime 100.14.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.