Skip To Content ArcGIS for Developers Sign In Dashboard

ExportTileCacheParameters Class


The parameters for estimating the size of and exporting a tile cache with the ExportTileCacheTask. More...

Header: #include <ExportTileCacheParameters>
Since: Esri::ArcGISRuntime 100.0

Public Functions

ExportTileCacheParameters(const ExportTileCacheParameters &other)
ExportTileCacheParameters(ExportTileCacheParameters &&other)
Geometry areaOfInterest() const
double compressionQuality() const
bool isEmpty() const
QList<int> levelIds() const
void setAreaOfInterest(const Geometry &areaOfInterest)
void setCompressionQuality(double compressionQuality)
void setLevelIds(const QList<int> &levelIds)
ExportTileCacheParameters &operator=(const ExportTileCacheParameters &other)
ExportTileCacheParameters &operator=(ExportTileCacheParameters &&other)

Detailed Description

The parameters for estimating the size of and exporting a tile cache with the ExportTileCacheTask.

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

Member Function Documentation


Default constructor.

ExportTileCacheParameters::ExportTileCacheParameters(const ExportTileCacheParameters &other)

Copy constructor from other ExportTileCacheParameters.

ExportTileCacheParameters::ExportTileCacheParameters(ExportTileCacheParameters &&other)

Move constructor from other ExportTileCacheParameters.



Geometry ExportTileCacheParameters::areaOfInterest() const

Returns a Geometry (Polygon or Envelope) that defines the geographic area for which tiles are needed.

See also setAreaOfInterest.

double ExportTileCacheParameters::compressionQuality() const

Returns the quality that must be maintained while compressing the tiles.

If the compression quality is not set, NaN is returned.

Compression quality is a value from 0 to 100 or NaN. A lower number reduces the size of the exported tile package, but reduces the quality. This applies to JPEG format tiles. If the value is NaN the service will use its default compression quality. The default compression value for the service is accessible on the services metadata under TileInfo::compressionQuality.

See also setCompressionQuality().

bool ExportTileCacheParameters::isEmpty() const

Returns true if this ExportTileCacheParameters is empty.

QList<int> ExportTileCacheParameters::levelIds() const

Returns the level IDs that should be included in the tile cache.

See also setLevelIds().

void ExportTileCacheParameters::setAreaOfInterest(const Geometry &areaOfInterest)

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

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 ExportTileCacheParameters::setCompressionQuality(double compressionQuality)

Sets the compressionQuality that must be maintained while compressing the tiles.

See also compressionQuality().

void ExportTileCacheParameters::setLevelIds(const QList<int> &levelIds)

Sets the levelIds that should be included in the tile cache.

The values should correspond to level IDs in the service's tiling scheme. You can specify consecutive levels ( for example 1,2,3,4,5) or skip some levels (for example for the ranges 1-3 and 7-9 you would specify 1,2,3,7,8,9).

See also levelIds().

ExportTileCacheParameters &ExportTileCacheParameters::operator=(const ExportTileCacheParameters &other)

Assignment operator from other ExportTileCacheParameters.

ExportTileCacheParameters &ExportTileCacheParameters::operator=(ExportTileCacheParameters &&other)

Move operator from other ExportTileCacheParameters.

Feedback on this topic?