Click or drag to resize

ExportVectorTilesTask Class

A task used to export vector tiles and optionally a portal item's vector tile style resources.
Inheritance Hierarchy
SystemObject
  Esri.ArcGISRuntime.Tasks.OfflineExportVectorTilesTask

Namespace:  Esri.ArcGISRuntime.Tasks.Offline
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.11.0
Syntax
public sealed class ExportVectorTilesTask : IApiKeyResource

The ExportVectorTilesTask type exposes the following members.

Properties
  NameDescription
Public propertyApiKey
Gets or sets the unique key generated from ArcGIS Developers website.
Public propertyCredential
Gets or sets the security credential used to access a remote task.
Public propertyHasStyleResources
Gets a value indicating if the task's associated PortalItem has style resources that override the default style of the vector tile service.
Public propertyPortalItem
Gets the PortalItem representing the vector tile service associated with this task.
Public propertyServiceUri Obsolete.
Gets the vector tile service Uri associated with this task.
Public propertyUri
Gets the Uri for exporting vector tiles.
Public propertyVectorTileSourceInfo
Gets the VectorTileSourceInfo associated with the task's vector tile service.
Top
Methods
  NameDescription
Public methodStatic memberCreateAsync(PortalItem)
Initializes a new instance of the ExportVectorTilesTask class from the given PortalItem.
Public methodStatic memberCreateAsync(Uri, Credential)
Initializes a new instance of the ExportVectorTilesTask class from a vector tile service.
Public methodStatic memberCreateAsync(Uri, String)
Initializes a new instance of the ExportVectorTilesTask class from a vector tile service.
Public methodCreateDefaultExportVectorTilesParametersAsync
Creates default ExportVectorTilesParameters.
Public methodExportStyleResourceCache
Creates a new ExportVectorTilesJob for downloading only the ItemResourceCache containing the vector tiles custom style resource cache. The VectorTileCache itself is not downloaded.
Public methodExportVectorTiles(ExportVectorTilesParameters, String)
Creates a new ExportVectorTilesJob for downloading a VectorTileCache.
Public methodExportVectorTiles(ExportVectorTilesParameters, String, String)
Creates a new ExportVectorTilesJob for downloading a VectorTileCache and any custom vector tile styles as ItemResourceCache objects.
Top
Remarks

Vector tiles are exported as a vector tile package (.vtpk) file, VectorTileCache. A portal item can contain custom style resources overriding the vector tile services default style and this can be checked with HasStyleResources. The custom style is exported separately as an ItemResourceCache.

The export vector tiles task can be initialized with a Uri using CreateAsync(Uri, Credential). 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.

See Also