GenerateOfflineMapParameters Class

Member Function Documentation

GenerateOfflineMapParameters::GenerateOfflineMapParameters()

Default constructor.

[since Esri::ArcGISRuntime 100.4] GenerateOfflineMapParameters::GenerateOfflineMapParameters(const Esri::ArcGISRuntime::Geometry &areaOfInterest, double minScale, double maxScale)

Creates a generate offline map parameters object.

• areaOfInterest - Area of interest.
• minScale - Min scale.
• maxScale - Max scale.

The area of interest must have a spatial reference. If min_scale or max_scale is zero that implies there is no bound on the scale. If both are non-zero, they must both be positive with min_scale greater than max_scale.

This function was introduced in Esri::ArcGISRuntime 100.4.

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

Copy constructor from other GenerateOfflineMapParameters.

GenerateOfflineMapParameters::GenerateOfflineMapParameters(Esri::ArcGISRuntime::GenerateOfflineMapParameters &&other)

Move constructor from other GenerateOfflineMapParameters.

GenerateOfflineMapParameters::~GenerateOfflineMapParameters()

Destructor.

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

Returns the area of interest for the offline map.

This is used for the extent of offline tile caches, geodatabases and the offline map's GeoModel::initialViewpoint property.

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, features and tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting offline map. Note that the filtered set of tiles may vary, depending on the underlying service.

See also setAreaOfInterest().

Esri::ArcGISRuntime::AttachmentSyncDirection GenerateOfflineMapParameters::attachmentSyncDirection() const

Returns specifies the direction for attachments to be synchronized when syncing offline feature layers.

This method should be used in conjunction with returnLayerAttachmentOption to determine which layers should be taken offline with attachments included. This property is valid when the service resource sync capabilities includes supportsAttachmentsSyncDirection otherwise it is ignored.

This property works in conjunction with returnLayerAttachmentOption and in some cases may have its value overridden by returnLayerAttachmentOption.

The table below shows the valid combinations of values for layer attachment options and attachment sync direction. The notes column explains where the behavior for a given layer may differ from the values set for these properties.

If GenerateOfflineMapParameters is used in conjunction with GenerateOfflineMapParameterOverrides this property is superseded.

See also setAttachmentSyncDirection().

[since Esri::ArcGISRuntime 100.4] Esri::ArcGISRuntime::DestinationTableRowFilter GenerateOfflineMapParameters::destinationTableRowFilter() const

Returns whether tables will contain all rows or can be filtered to a smaller set of related rows.

When the property is DestinationTableRowFilter::RelatedOnly (the default) this can substantially reduce the number of rows in offline tables to only those that are related to rows from other layers or tables. Only tables present in GeoModel::tables are considered as candidates for filtering.

This does not apply when the table:

• Is the origin of a relationship and not a destination
• Is a destination of a relationship from a layer or table that is not in the map
• Is editable and isReturnSchemaOnlyForEditableLayers is true
• Has a ServiceFeatureTable::definitionExpression and isDefinitionExpressionFilterEnabled is true

The relationships of a table are accessible via ArcGISFeatureTable::layerInfo and the ArcGISFeatureLayerInfo::relationshipInfos property.

The default value is DestinationTableRowFilter::RelatedOnly.

If set to DestinationTableRowFilter::All then all rows in tables are returned.

This function was introduced in Esri::ArcGISRuntime 100.4.

See also setDestinationTableRowFilter().

[since Esri::ArcGISRuntime 100.10] Esri::ArcGISRuntime::EsriVectorTilesDownloadOption GenerateOfflineMapParameters::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().

[since Esri::ArcGISRuntime 100.4] bool GenerateOfflineMapParameters::isContinueOnErrors() const

Indicates whether or not a generate offline map job should continue running in the event of failure to take a layer offline.

Returns true if the GenerateOfflineMapJob is to continue running in the event of failure.

If this property is true, failure to take a layer or table offline will not fail the job and the failure will be exposed in the job result. If this property is false, failure to take a layer or table offline will fail the job and no more layers or tables will be taken offline. The layer or table's error will be available as the job's error.

The default value is true.

This function was introduced in Esri::ArcGISRuntime 100.4.

[since Esri::ArcGISRuntime 100.3] bool GenerateOfflineMapParameters::isDefinitionExpressionFilterEnabled() const

Returns if feature layer definition expressions are used when taking feature layers and tables offline.

A value of true allows GenerateOfflineMapJob to use the SQL where clause in FeatureLayer::definitionExpression as a filter when generating offline geodatabases.

Applying the definition expression may reduce the number of features taken offline for display and sync.

If the value is false this could result in a larger geodatabase than is required to display the feature layer.

The default value is true.

For tables the definition expression is taken from the property ServiceFeatureTable::definitionExpression.

If GenerateOfflineMapParameters is used in conjunction with GenerateOfflineMapParameterOverrides this property is superseded.

This function was introduced in Esri::ArcGISRuntime 100.3.

bool GenerateOfflineMapParameters::isIncludeBasemap() const

Returns whether or not a basemap will be included in the offline map.

If you do not want a basemap in the offline map then set this property to false. After loading the offline map, your application can programmatically insert a basemap into the map. Note that, a programmatically inserted basemap will not be persisted in the map.

If you want a basemap in the offline map then set this property to true. You can choose to either:

• Generate and download the online basemap using the GenerateOfflineMapJob. This is the default.
• Use a local basemap on the device by setting the referenceBasemapDirectory

The default value is true.

This property is superseded if the GenerateOfflineMapParameters is used in conjunction with GenerateOfflineMapParameterOverrides.

bool GenerateOfflineMapParameters::isReturnSchemaOnlyForEditableLayers() const

Returns whether or not feature layers taken offline should be schema only and contain no data.

For an upload only type workflow, this property can be set to true to take feature layers offline with no existing data in them. If GenerateOfflineMapParameters is used in conjunction with GenerateOfflineMapParameterOverrides this property is superseded.

Esri::ArcGISRuntime::OfflineMapItemInfo GenerateOfflineMapParameters::itemInfo() const

Returns the offline map item info used for the local item properties in the offline map.

If this property is empty then the properties are copied from the portal item.

See also setItemInfo().

double GenerateOfflineMapParameters::maxScale() const

Returns the maximum scale for how far in to extract tiles from tiled services.

The default value of 0 means extract the levels down to the most detailed.

This is used as the input for the levels of detail in a TileCache. This is not applicable to offline data in a VectorTileCache or a Geodatabase.

A minScale of 100000 and a maxScale of 500 will select level IDs between 1:500 and 1:100,000 scale. A minScale of 0 and a maxScale of 500 will select all global level IDs down to 1:500 scale. A minScale of 100000 and a maxScale of 0 will select level IDs from 1:100,000 scale to the most detailed available level.

If GenerateOfflineMapParameters is used in conjunction with GenerateOfflineMapParameterOverrides, this property is superseded for individual layers tiled services.

Note that this property only sets the levels of detail to download for tiled data. The offline basemap layers will use the same max scale as in the online web map (either defined by the service or on the layer itself) to allow zooming in.

See also setMaxScale().

double GenerateOfflineMapParameters::minScale() const

Returns the minimum scale for how far out data will be in tile caches.

The 0 default means extract all the available detailed levels to global scales. This is used as input for levels of detail for TileCache.

This is not applicable to offline data in VectorTileCache or Geodatabase.

A minScale of 100000 and a maxScale of 500 will select level IDs between 1:500 and 1:100,000 scale.

A minScale of 0 and a maxScale of 500 will select all global level IDs down to 1:500 scale.

A minScale of 100000 and a maxScale of 0 will select level IDs from 1:100,000 scale to the most detailed available level.

If GenerateOfflineMapParameters is used in conjunction with GenerateOfflineMapParameterOverrides, this property is superseded for individual layers tile caches.

Note that this property only sets the levels of detail to download for tiled data. The offline basemap layers will use the same min scale as in the online web map (either defined by the service or on the layer itself).

See also setMinScale().

[since Esri::ArcGISRuntime 100.9] Esri::ArcGISRuntime::OnlineOnlyServicesOption GenerateOfflineMapParameters::onlineOnlyServicesOption() const

Returns how data that requires an online service will be handled when taking a map offline.

Online layers and tables cannot be taken offline in the following situations:

• The layer or table is using a service that cannot be taken offline. For example, WmsLayer or WmtsLayer.
• The layer or table is using a service that supports offline, such as a FeatureLayer, but synchronization has not been enabled on the service (FeatureServiceCapabilities::isSupportsSync is set to false). Services utilize synchronization to take layers and tables offline and synchronize changes.

Online services that cannot be taken offline are referred to as online-only services. Online-only services require network connectivity and may involve authentication. Examples of online-only services include:

• Dynamic information, such as changing weather or traffic conditions, that delivers frequent and regular updates to the app.
• Large datasets that would be impractical to take offline to a device.

This property allows you to specify how online-only data will be handled when taking the map offline. There are three options:

• OnlineOnlyServicesOption::Exclude means that any data that cannot be taken offline will be omitted from the offline map. Choosing this option means that your offline map will not require a network connection but may not include all of the data from the original web map.
• OnlineOnlyServicesOption::Include means that data that cannot be taken offline will be accessed via the URL in the offline map. Choosing this option means that your offline map will retain all of the information from the original web map, but it will require a network connection and may require authentication.
• OnlineOnlyServicesOption::UseAuthoredSettings means that layers and tables will be taken offline, remain online or be omitted from the offline map according to the map author's intent as defined in the web map.

The default value is OnlineOnlyServicesOption::Exclude.

This function was introduced in Esri::ArcGISRuntime 100.9.

See also setOnlineOnlyServicesOption(), OfflineSettings::onlineLayers, and OfflineSettings::onlineTables.

[since Esri::ArcGISRuntime 100.5] QString GenerateOfflineMapParameters::referenceBasemapDirectory() const

Returns the path to a directory on the device where the local basemap file is located.

Set this property to use a basemap that is already on the device (rather than downloading it). The directory should only be set when the parameters have a referenceBasemapFilename defined.

This property supports any directory specified as either:

• An absolute path
• A path relative to the parent directory of the generated mobile map package (see downloadPath for OfflineMapTask::generateOfflineMap(const Esri::ArcGISRuntime::GenerateOfflineMapParameters&, const QString&))

If the directory does not exist, or does not contain the specified basemap, the GenerateOfflineMapJob will fail.

Note that, the mobile map package will store either a relative or absolute path to the reference basemap file so that it can be opened in the future.

A relative path typically begins with "." to denote the parent directory of the resulting mobile map package or ".." to move up one directory. The parent directory of the mobile map package will be set when calling OfflineMapTask::generateOfflineMap(const Esri::ArcGISRuntime::GenerateOfflineMapParameters&, const QString&).

For example, to generate a mobile map package to "[my root path]/my_offline_maps/my_mobile_map_package", that uses a reference basemap in "[my root path]/other_maps/my_basemap.tpk", you would set the relative path as follows:

• GenerateOfflineMapJob::downloadDirectoryPath to "[my root path]/my_offline_maps/my_mobile_map_package"
• referenceBasemapDirectory to "../other_maps"
• referenceBasemapFilename to "my_basemap.tpk"

Note that this property is ignored if isIncludeBasemap is false.

This function was introduced in Esri::ArcGISRuntime 100.5.

See also setReferenceBasemapDirectory().

[since Esri::ArcGISRuntime 100.5] QString GenerateOfflineMapParameters::referenceBasemapFilename() const

Returns the name of a local basemap file on the device that can be used rather than downloading an online basemap.

The local basemap filename must end with .tpk, .tpkx or .vtpk since these are the supported file formats.

This property can be read directly from settings applied by the author of the online web map (see OfflineSettings) or set by user code to a file known to be on the device. This property will be populated from online settings when created with {Esri::ArcGISRuntime::OfflineMapTask::createDefaultGenerateOfflineMapParametersAsync(const Esri::ArcGISRuntime::Geometry&)} {OfflineMapTask::createDefaultGenerateOfflineMapParametersAsync(const Esri::ArcGISRuntime::Geometry&)}.

If you wish to use the specified local basemap rather than downloading, you must also set referenceBasemapDirectory.

If the directory does not exist, or does not contain the specified basemap, the GenerateOfflineMapJob will fail.

The spatial reference of the reference basemap is used for the offline map when it is different to the online map's spatial reference.

Note that this property is ignored if isIncludeBasemap is false.

This function was introduced in Esri::ArcGISRuntime 100.5.

See also setReferenceBasemapFilename() and OfflineSettings.

Esri::ArcGISRuntime::ReturnLayerAttachmentOption GenerateOfflineMapParameters::returnLayerAttachmentOption() const

Returns the type of layers we wish to include attachments with when taking feature layers offline.

If GenerateOfflineMapParameters is used in conjunction with GenerateOfflineMapParameterOverrides this property is superseded.

See also setReturnLayerAttachmentOption.

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

Sets the areaOfInterest to areaOfInterest.

See also areaOfInterest.

void GenerateOfflineMapParameters::setAttachmentSyncDirection(Esri::ArcGISRuntime::AttachmentSyncDirection syncDirection)

Sets the attachmentSyncDirection to syncDirection.

See also attachmentSyncDirection.

[since Esri::ArcGISRuntime 100.4] void GenerateOfflineMapParameters::setContinueOnErrors(bool continueOnErrors)

Sets the continueOnErrors to continueOnErrors.

This function was introduced in Esri::ArcGISRuntime 100.4.

See also isContinueOnErrors.

[since Esri::ArcGISRuntime 100.3] void GenerateOfflineMapParameters::setDefinitionExpressionFilterEnabled(bool definitionExpressionFilterEnabled)

Sets the definitionExpressionFilterEnabled to definitionExpressionFilterEnabled.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also isDefinitionExpressionFilterEnabled.

[since Esri::ArcGISRuntime 100.4] void GenerateOfflineMapParameters::setDestinationTableRowFilter(Esri::ArcGISRuntime::DestinationTableRowFilter destinationTableRowFilter)

Sets the destinationTableRowFilter to destinationTableRowFilter.

This function was introduced in Esri::ArcGISRuntime 100.4.

See also destinationTableRowFilter.

[since Esri::ArcGISRuntime 100.10] void GenerateOfflineMapParameters::setEsriVectorTilesDownloadOption(Esri::ArcGISRuntime::EsriVectorTilesDownloadOption esriVectorTilesDownloadOption)

Sets the esriVectorTilesDownloadOption to esriVectorTilesDownloadOption.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also esriVectorTilesDownloadOption.

void GenerateOfflineMapParameters::setIncludeBasemap(bool includeBasemap)

Sets the includeBasemap to includeBasemap.

See also isIncludeBasemap.

void GenerateOfflineMapParameters::setItemInfo(const Esri::ArcGISRuntime::OfflineMapItemInfo &offlineMapItemInfo)

Sets the itemInfo to offlineMapItemInfo.

See also itemInfo.

void GenerateOfflineMapParameters::setMaxScale(double maxScale)

Sets the maxScale to maxScale.

See also maxScale.

void GenerateOfflineMapParameters::setMinScale(double minScale)

Sets the minScale to minScale.

See also minScale.

[since Esri::ArcGISRuntime 100.9] void GenerateOfflineMapParameters::setOnlineOnlyServicesOption(Esri::ArcGISRuntime::OnlineOnlyServicesOption onlineOnlyServicesOption)

Sets the onlineOnlyServicesOption to onlineOnlyServicesOption.

This function was introduced in Esri::ArcGISRuntime 100.9.

See also onlineOnlyServicesOption.

[since Esri::ArcGISRuntime 100.5] void GenerateOfflineMapParameters::setReferenceBasemapDirectory(const QString &referenceBasemapDirectory)

Sets the referenceBasemapDirectory to referenceBasemapDirectory.

This function was introduced in Esri::ArcGISRuntime 100.5.

See also referenceBasemapDirectory.

[since Esri::ArcGISRuntime 100.5] void GenerateOfflineMapParameters::setReferenceBasemapFilename(const QString &referenceBasemapFilename)

SSets the referenceBasemapFilename to referenceBasemapFilename.

The local basemap filename must end with .tpk, .tpkx or .vtpk since these are the supported file formats. This property can be read directly from settings applied by the author of the online web map or set by user code to a file known to be on the device.

This property can be read directly from settings applied by the author of the online web map or set by user code to a file known to be on the device. This property will be populated from online settings when created with OfflineMapTask::createDefaultGenerateOfflineMapParametersAsync.

To use the specified local basemap rather than downloading, the referenceBasemapDirectory property must also be set.

If the directory does not exist, or does not contain the specified basemap, GenerateOfflineMapJob will fail.

Note that this property is ignored if isIncludeBasemap is false.

This function was introduced in Esri::ArcGISRuntime 100.5.

See also referenceBasemapFilename.

void GenerateOfflineMapParameters::setReturnLayerAttachmentOption(Esri::ArcGISRuntime::ReturnLayerAttachmentOption layerAttachmentOption)

Sets the type of layers we wish to include attachments with when taking feature layers offline to layerAttachmentOption.

Values for ReturnLayerAttachmentOption can indicate to return attachments with none of the layers, all of the layers, only read-only layers, or editable layers.

See the class description for more information about the interaction of this property with other properties.

If GenerateOfflineMapParameters is used in conjunction with GenerateOfflineMapParameterOverrides this property is superseded.

See also returnLayerAttachmentOption().

void GenerateOfflineMapParameters::setReturnSchemaOnlyForEditableLayers(bool returnSchemaOnly)

Sets the returnSchemaOnlyForEditableLayers to returnSchemaOnly.

See also isReturnSchemaOnlyForEditableLayers.

[since Esri::ArcGISRuntime 100.9] void GenerateOfflineMapParameters::setUpdateMode(Esri::ArcGISRuntime::GenerateOfflineMapUpdateMode updateMode)

Sets the updateMode to updateMode.

This function was introduced in Esri::ArcGISRuntime 100.9.

See also updateMode.

[since Esri::ArcGISRuntime 100.9] Esri::ArcGISRuntime::GenerateOfflineMapUpdateMode GenerateOfflineMapParameters::updateMode() const

Returns how the offline map will support synchronization with online services.

A value of GenerateOfflineMapUpdateMode::noUpdates instructs GenerateOfflineMapJob to disable data synchronization for generated offline geodatabases. In this case no synchronization replicas will be created on corresponding feature services.

A value of GenerateOfflineMapUpdateMode::NoUpdates instructs the GenerateOfflineMapJob to disable data synchronization for generated offline geodatabases. In this case, no synchronization replicas will be created on corresponding feature services. This reduces the load on the feature server and frees the developer from needing to unregister server replicas when they are no longer needed.

The default value is GenerateOfflineMapUpdateMode::syncWithFeatureServices.

If GenerateOfflineMapParameters is used in conjunction with GenerateOfflineMapParameterOverrides this property is superseded by the GenerateGeodatabaseParameters::syncModel property of the overridden layer.

This function was introduced in Esri::ArcGISRuntime 100.9.

See also setUpdateMode() and GenerateGeodatabaseParameters::syncModel.

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

Assignment operator from other GenerateOfflineMapParameters.

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

Move operator from other GenerateOfflineMapParameters.