ExportVectorTileCache Method

In This Topic

Export vector tile caches from the map using the specified ExportTileCacheParams. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void ExportVectorTileCache( 
   Map map,
   ExportTileCacheParams cacheParams
)

Public Sub ExportVectorTileCache( _
   ByVal map As Map, _
   ByVal cacheParams As ExportTileCacheParams _
)

Parameters

map: The map whose vector tile service content will be exported
cacheParams: The parameters to use for the export

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentNullException	Map cannot be null
System.ArgumentException	Extent cannot be null or empty
System.ArgumentException	Map and extent spatial references must be equal
System.InvalidOperationException	No vector tile cache content to export

Remarks

Exported vector tile caches are copied to the specified ExportTileCacheParams.DestinationFolder. Use GetCanExportVectorTileCache to determine if a map has vector tile service content that can be exported.
If a map has no vector tile service content that can be exported a System.InvalidOperationException is thrown. At the conclusion of the export, a layer is created for each exported vector tile cache.

Example

Export Map Vector Tile Cache Content

//namespace ArcGIS.Desktop.Mapping.Offline
var extent = MapView.Active.Extent;
var map = MapView.Active.Map;

//await if needed...
QueuedTask.Run(() =>
{
  //Does the map have any exportable vector tile content?
  var canExport = GenerateOfflineMap.Instance.GetCanExportVectorTileCache(map);
  if (canExport)
  {
    //Check the available LOD scale ranges
    var scales = GenerateOfflineMap.Instance.GetExportVectorTileCacheScales(map, extent);
    //Pick the desired LOD scale
    var max_scale = scales[scales.Count() / 2];

    //Configure the export parameters
    var export_params = new ExportTileCacheParams()
    {
      Extent = extent,//Use same extent as was used to retrieve scales
      MaximumUserDefinedScale = max_scale,
      DestinationFolder = @"C:\Data\Offline"
    };
    //If DestinationFolder is not set, output defaults to project
    //offline maps location set in the project properties. If that is 
    //not set, output defaults to the current project folder location.

    //Do the export. Depending on the MaximumUserDefinedScale and the
    //area of the extent requested, this can take minutes for tile packages
    //over 1 GB or less if your network speed is slow...
    GenerateOfflineMap.Instance.ExportVectorTileCache(map, export_params);
  }
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

GenerateOfflineMap Class
GenerateOfflineMap Members

Send feedback