Class ExportVectorTilesTask

A task to download vector tiles with their default style or with their associated custom style resources. Optionally, the task can download only the custom style resources.

Inheritance

System.Object

ExportVectorTilesTask

Implements

IApiKeyResource

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Esri.ArcGISRuntime.Tasks.Offline

Assembly: Esri.ArcGISRuntime.dll

Syntax

public sealed class ExportVectorTilesTask : IApiKeyResource

Remarks

Vector tiles are exported as a vector tile package (.vtpk) file, see VectorTileCache, from a vector tile service. The vector tile service must support the creation of an offline vector tile cache; specifically, it must enable the "exportTiles" operation.

Vector tiles contain vector representations of data that can be restyled for different purposes, such as day and night viewing. You can download default styling resources along with the vector tiles and custom style resources from ArcGIS Portal items that host vector tile layers. You can checked whether the vector tiles have custom styles using HasStyleResources. Custom styles are exported separately as an ItemResourceCache.

The export vector tiles task can be initialized with a Uri using CreateAsync(Uri). The Uri can be to:

A vector tile server that ends in "VectorTileServer" and is the REST end-point used to export vector tile packages. The vector tile service must be enabled for export or the task will fail to load.
A portal item for a vector tile service or a vector tiled layer with a custom style applied.
A vector basemap layer created using a BasemapStyle.

Alternatively a PortalItem, referencing a vector tile service or a custom style for a vector tiled layer, can be used with CreateAsync(PortalItem).

When using Esri provided vector basemaps that do not support exporting tiles (such as the ArcGIS streets basemap - ArcGISStreets), an alternative service that supports exporting tiles will be used instead.

Properties

Name	Description
ApiKey	Gets or sets the API key that allows your app to access ArcGIS location services and private portal items.
HasStyleResources	Gets a value indicating whether the task's associated PortalItem has style resources that override the default style of the vector tile service.
PortalItem	Gets the task's portal item which must be of type VectorTileService.
Uri	Gets the Uri for exporting vector tiles.
VectorTileSourceInfo	Gets the VectorTileSourceInfo associated with the task's vector tile service.

Methods

Name	Description
CreateAsync(PortalItem)	Initializes a new instance of the ExportVectorTilesTask class from the given PortalItem.
CreateAsync(Uri)	Initializes a new instance of the ExportVectorTilesTask class from a vector tile service.
CreateAsync(Uri, String)	Initializes a new instance of the ExportVectorTilesTask class from a vector tile service.
CreateDefaultExportVectorTilesParametersAsync(Geometry, Double)	Creates default ExportVectorTilesParameters.
ExportStyleResourceCache(String)	Creates a new ExportVectorTilesJob for downloading only the ItemResourceCache containing the vector tiles custom style resource cache. The VectorTileCache itself is not downloaded.
ExportVectorTiles(ExportVectorTilesParameters, String)	Creates a new ExportVectorTilesJob for downloading a VectorTileCache.
ExportVectorTiles(ExportVectorTilesParameters, String, String)	Creates a new ExportVectorTilesJob for downloading a VectorTileCache and any custom vector tile styles as ItemResourceCache objects.

Applies to

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 200.8
.NET Windows	100.13 - 200.8
.NET Android	200.0 - 200.8
.NET iOS	200.0 - 200.8
.NET Framework	100.2.1 - 200.8
Xamarin.Android	100.2.1 - 100.15
Xamarin.iOS	100.2.1 - 100.15
UWP	100.2.1 - 200.8