ArcGIS Developers
Dashboard

ExportVectorTilesParameters Class

class Esri::ArcGISRuntime::ExportVectorTilesParameters

The parameters for exporting a vector tile cache with an ExportVectorTilesTask. More...

Header: #include <ExportVectorTilesParameters>
Since: Esri::ArcGISRuntime 100.2

This class was introduced in Esri::ArcGISRuntime 100.2.

Public Functions

ExportVectorTilesParameters(Esri::ArcGISRuntime::ExportVectorTilesParameters &&other)
ExportVectorTilesParameters(const Esri::ArcGISRuntime::ExportVectorTilesParameters &other)
ExportVectorTilesParameters(const Esri::ArcGISRuntime::Geometry &areaOfInterest)
ExportVectorTilesParameters()
Esri::ArcGISRuntime::ExportVectorTilesParameters &operator=(Esri::ArcGISRuntime::ExportVectorTilesParameters &&other)
Esri::ArcGISRuntime::ExportVectorTilesParameters &operator=(const Esri::ArcGISRuntime::ExportVectorTilesParameters &other)
~ExportVectorTilesParameters()
Esri::ArcGISRuntime::Geometry areaOfInterest() const
Esri::ArcGISRuntime::EsriVectorTilesDownloadOption esriVectorTilesDownloadOption() const
int maxLevel() const
void setAreaOfInterest(const Esri::ArcGISRuntime::Geometry &areaOfInterest)
void setEsriVectorTilesDownloadOption(Esri::ArcGISRuntime::EsriVectorTilesDownloadOption esriVectorTilesDownloadOption)
void setMaxLevel(int maxLevel)

Detailed Description

Use ExportVectorTilesTask::createDefaultExportVectorTilesParameters to generate parameters with the service defaults preset, and then modify these parameters with any desired changes.

Member Function Documentation

ExportVectorTilesParameters::ExportVectorTilesParameters(Esri::ArcGISRuntime::ExportVectorTilesParameters &&other)

Move constructor from other ExportVectorTilesParameters.

ExportVectorTilesParameters::ExportVectorTilesParameters(const Esri::ArcGISRuntime::ExportVectorTilesParameters &other)

Copy constructor from other ExportVectorTilesParameters.

ExportVectorTilesParameters::ExportVectorTilesParameters(const Esri::ArcGISRuntime::Geometry &areaOfInterest)

Constructor that takes an areaOfInterest Geometry.

ExportVectorTilesParameters::ExportVectorTilesParameters()

Default constructor.

Esri::ArcGISRuntime::ExportVectorTilesParameters &ExportVectorTilesParameters::operator=(Esri::ArcGISRuntime::ExportVectorTilesParameters &&other)

Move operator from other ExportVectorTilesParameters.

Esri::ArcGISRuntime::ExportVectorTilesParameters &ExportVectorTilesParameters::operator=(const Esri::ArcGISRuntime::ExportVectorTilesParameters &other)

Assignment operator from other ExportVectorTilesParameters.

ExportVectorTilesParameters::~ExportVectorTilesParameters()

Destructor

Esri::ArcGISRuntime::Geometry ExportVectorTilesParameters::areaOfInterest() const

Returns a Geometry that defines the geographic area for which vector tiles are needed.

See also setAreaOfInterest.

Esri::ArcGISRuntime::EsriVectorTilesDownloadOption ExportVectorTilesParameters::esriVectorTilesDownloadOption() const

Returns how Esri vector tiled basemap layers will be downloaded.

This property lets you choose how to download Esri vector tiled basemap layers. This property only applies when taking an Esri vector tile basemap service offline.

When taking an Esri vector tiled basemap service offline (e.g. to create a VectorTileCache on your device), you can choose from different versions of the service depending on your use case.

Primary considerations are the download speed and the size of the resulting .vtpk file. Among other things, file size is influenced by the number of fonts downloaded from the service. Esri vector tiled basemap layers use fonts as part of their style resources - see the vector-tile-style documentation. When you take a vector tiled layer offline, these fonts are downloaded as part of the VectorTileCache.

Esri services also offer an alternative version with a reduced font package size. This omits the large Arial Unicode font, which greatly reduces the download size. You can view the set of reduced font vector tile services here.

  • If you choose EsriVectorTilesDownloadOption::UseOriginalService, the full set of resources used by the original online service, including all fonts, will be downloaded. This increases the download size of the VectorTileCache but ensures that the offline layer will display the same as the original online data.
  • If you choose EsriVectorTilesDownloadOption::UseReducedFontsService, the smaller set of fonts used by the alternative, for export version of the service will be downloaded. This reduces the download size of the VectorTileCache but is not suitable for all locales or when your offline vector tiled layer includes certain language characters. For example, this option will not display Chinese, Japanese, Thai, Korean or Georgian characters. If an alternative, for export version of the service cannot be found, the original service will be used.

The default value is EsriVectorTilesDownloadOption::UseOriginalService.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also setEsriVectorTilesDownloadOption().

int ExportVectorTilesParameters::maxLevel() const

Returns the maximum level of detail that should be included in the vector tile cache.

See also setMaxLevel().

void ExportVectorTilesParameters::setAreaOfInterest(const Esri::ArcGISRuntime::Geometry &areaOfInterest)

Sets the the Geometry (Polygon or Envelope) that defines the geographic area for which vector tiles are needed to areaOfInterest.

The supported geometry types for the area of interest are Envelope and Polygon. The area of interest must have a spatial reference. Where a Polygon is supplied, tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting tile package. Note that the filtered set of tiles may vary, depending on the underlying service.

See also areaOfInterest().

void ExportVectorTilesParameters::setEsriVectorTilesDownloadOption(Esri::ArcGISRuntime::EsriVectorTilesDownloadOption esriVectorTilesDownloadOption)

Sets the esriVectorTilesDownloadOption to esriVectorTilesDownloadOption.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also esriVectorTilesDownloadOption.

void ExportVectorTilesParameters::setMaxLevel(int maxLevel)

Sets the the maximum level of detail that should be included in the vector tile cache to maxLevel.

Note: This must be set to a valid value greater than or equal to 0.

The task will export level 0 and all levels up to and including the set value.

See also maxLevel().


Feedback on this topic?