Class VectorTileCache
Metadata for a local on-disk cache of vector map tiles that can be used to create a layer.
Implements
Namespace: Esri.ArcGISRuntime.Mapping
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class VectorTileCache : ILoadableRemarks
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.
Constructors
| Name | Description |
|---|---|
| VectorTileCache(String) | Initializes a new instance of the VectorTileCache class from the specified cache path. |
Properties
| Name | Description |
|---|---|
| LoadError | Gets the Exception associated with the last load error. |
| LoadStatus | Gets the load status. |
| Path | Gets the full path of the vector tile cache (.vtpk file). |
| SourceInfo | Gets the VectorTileSourceInfo used by this vector tile cache. |
| Thumbnail | Gets the thumbnail image of this tile cache. |
Methods
| Name | Description |
|---|---|
| CancelLoad() | Cancel loading metadata for the object. |
| CreateAsync(String) | Creates and loads a new instance of the VectorTileCache class from the specified cache path. |
| LoadAsync() | Load the metadata for the object asynchronously. |
| RetryLoadAsync() | Loads or retries loading metadata for the object asynchronously. |
Events
| Name | Description |
|---|---|
| Loaded | Event that is raised when the object is done loading. |
| LoadStatusChanged | Event that is raised when the LoadStatus property changes. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.2.1 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.2.1 - 100.15 |
| Xamarin.iOS | 100.2.1 - 100.15 |
| UWP | 100.2.1 - 100.15 |