Skip To Content ArcGIS for Developers Sign In Dashboard

GenerateOfflineMapParameterOverrides Class

(Esri::ArcGISRuntime::GenerateOfflineMapParameterOverrides)

Gives access to the the individual parameters objects that will generate the various geodatabase, vector tile and tile cache packages that make up the data of an offline map. More...

Header: #include <GenerateOfflineMapParameterOverrides>
Since: Esri::ArcGISRuntime 100.4
Inherits: Object

Public Functions

~GenerateOfflineMapParameterOverrides()
QMap<OfflineMapParametersKey, ExportTileCacheParameters> exportTileCacheParameters() const
QMap<OfflineMapParametersKey, ExportVectorTilesParameters> exportVectorTilesParameters() const
QMap<OfflineMapParametersKey, GenerateGeodatabaseParameters> generateGeodatabaseParameters() const
void setExportTileCacheParameters(const QMap<OfflineMapParametersKey, ExportTileCacheParameters> &exportTileCacheParameters)
void setExportVectorTilesParameters(const QMap<OfflineMapParametersKey, ExportVectorTilesParameters> &exportVectorTilesParameters)
void setGenerateGeodatabaseParameters(const QMap<OfflineMapParametersKey, GenerateGeodatabaseParameters> &generateGeodatabaseParameters)
  • 31 public functions inherited from QObject

Additional Inherited Members

Detailed Description

Gives access to the the individual parameters objects that will generate the various geodatabase, vector tile and tile cache packages that make up the data of an offline map.

This object allows the user more fine-grained control over the generation of an offline map than the options presented in the standard GenerateOfflineMapParameters.

For example, the parameter overrides allows the user to adjust specific layers so that they:

  • use a different spatial extent or scale range.
  • use custom attribute or geometry settings.
  • are omitted from the download.

An instance of this object can be created from the overall map settings in a pre-existing GenerateOfflineMapParameters by calling OfflineMapTask::createGenerateOfflineMapParameterOverrides. This object gives access to the individual parameter objects via three dictionaries containing generate geodatabase parameters, export tile cache parameters and export vector tile parameters. These can be accessed using generateGeodatabaseParameters, exportTileCacheParameters and exportVectorTilesParameters respectively.

The dictionaries contain the various parameters objects mapped against an OfflineMapParametersKey. An OfflineMapParametersKey represents the service that a particular parameters object is intended for. A key can be constructed using a layer or service feature table. The returned key's OfflineMapParametersKey::type property will indicate which of the three dictionaries contains the desired parameters object and the key can be used to extract it.

Note: A given parameters key/value pair may be shared by multiple layers in the map: for example a single GenerateGeodatabaseParameters could represent the online settings for multiple feature layers which all access the same underlying feature service.

Member Function Documentation

GenerateOfflineMapParameterOverrides::~GenerateOfflineMapParameterOverrides()

Destructor.

QMap<OfflineMapParametersKey, ExportTileCacheParameters> GenerateOfflineMapParameterOverrides::exportTileCacheParameters() const

Returns the dictionary of OfflineMapParametersKey to ExportTileCacheParameters.

All entries in the dictionary should correspond to ArcGISTiledLayer instances in the online map. If a dictionary entry is removed, the corresponding layers will be removed from the offline map without raising an error.

See also setExportTileCacheParameters().

QMap<OfflineMapParametersKey, ExportVectorTilesParameters> GenerateOfflineMapParameterOverrides::exportVectorTilesParameters() const

Returns the dictionary of OfflineMapParametersKey to ExportVectorTilesParameters.

All entries in the dictionary should correspond to ArcGISVectorTiledLayer instances in the online map. If a dictionary entry is removed the corresponding layers will be removed from the offline map without raising an error.

See also setExportVectorTilesParameters().

QMap<OfflineMapParametersKey, GenerateGeodatabaseParameters> GenerateOfflineMapParameterOverrides::generateGeodatabaseParameters() const

Returns the dictionary of OfflineMapParametersKey to GenerateGeodatabaseParameters.

All entries in the dictionary should correspond to FeatureLayer and ServiceFeatureTable instances in the online map. If a dictionary entry is removed the corresponding layers or tables will be removed from the offline map without raising an error.

See also setGenerateGeodatabaseParameters().

void GenerateOfflineMapParameterOverrides::setExportTileCacheParameters(const QMap<OfflineMapParametersKey, ExportTileCacheParameters> &exportTileCacheParameters)

Sets the dictionary of export tile cache parameters to exportTileCacheParameters.

All entries in the dictionary should correspond to ArcGISTiledLayer instances in the online map. If a dictionary entry is removed the corresponding layers will be removed from the offline map without raising an error.

See also exportTileCacheParameters().

void GenerateOfflineMapParameterOverrides::setExportVectorTilesParameters(const QMap<OfflineMapParametersKey, ExportVectorTilesParameters> &exportVectorTilesParameters)

Sets the dictionary of export vector tiles parameters to exportVectorTilesParameters.

All entries in the dictionary should correspond to ArcGISVectorTiledLayer instances in the online map. If a dictionary entry is removed the corresponding layers will be removed from the offline map without raising an error.

See also exportVectorTilesParameters().

void GenerateOfflineMapParameterOverrides::setGenerateGeodatabaseParameters(const QMap<OfflineMapParametersKey, GenerateGeodatabaseParameters> &generateGeodatabaseParameters)

Sets the dictionary of generate geodatabase parameters to generateGeodatabaseParameters.

All entries in the dictionary should correspond to FeatureLayer and ServiceFeatureTable instances in the online map. If a dictionary entry is removed the corresponding layers or tables will be removed from the offline map without raising an error.

See also generateGeodatabaseParameters().


Feedback on this topic?