Click or drag to resize

VectorTileCache Class

Metadata for a local on-disk cache of vector map tiles that can be used to create a layer.
Inheritance Hierarchy
SystemObject
  Esri.ArcGISRuntime.MappingVectorTileCache

Namespace:  Esri.ArcGISRuntime.Mapping
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.7.0.0
Syntax
C#
public sealed class VectorTileCache : ILoadable

The VectorTileCache type exposes the following members.

Constructors
  NameDescription
Public methodVectorTileCache
Initializes a new instance of the VectorTileCache class from the specified cache path.
Top
Properties
  NameDescription
Public propertyLoadError
Gets the Exception associated with the last load error.
Public propertyLoadStatus
Gets the load status.
Public propertyPath
Gets the full path of the vector tile cache (.vtpk file).
Public propertySourceInfo
Gets the VectorTileSourceInfo used by this vector tile cache.
Public propertyThumbnail
Gets the thumbnail image of this tile cache.
Top
Methods
  NameDescription
Public methodCancelLoad
Cancel loading metadata for the object.
Public methodStatic memberCreateAsync
Creates and loads a new instance of the VectorTileCache class from the specified cache path.
Public methodLoadAsync
Load the metadata for the object asynchronously.
Public methodRetryLoadAsync
Load or retry loading metadata for the object asynchronously.
Top
Events
  NameDescription
Public eventLoaded
Event that is raised when the object is done loading.
Public eventLoadStatusChanged
Event that is raised when the LoadStatus property changes.
Top
Remarks

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 export vector tiles job, or alternatively can be provisioned directly to local storage. A VectorTileCache is often used as a basemap, but can also be used to create an ArcGISVectorTiledLayer that is added to a map as an operational layer.

Currently the only supported type of cache is:

  • Vector tile package (.vtpk) - a map and the tile cache of the data contained within it, packaged into one convenient, portable file, ideal for offline sharing or complete map documents in a disconnected environment or via a portal.
See Also