ExportVectorTilesTask Class

Member Function Documentation

[explicit] ExportVectorTilesTask::ExportVectorTilesTask(const QUrl &url, QObject *parent = nullptr)

Initialize an export vector tiles task with a URL to a vector tile service.

• url - The URL of a service or portal item to be used for exporting vector tiles.
• parent - The optional parent QObject.

The URL can be for:

• A vector tile server that ends in "VectorTileServer" and is the REST endpoint used to export vector tile packages. The vector tile service must be enabled for export or the task will fail to load.
• A PortalItem for a vector tile service or a vector tiled layer with a custom style applied.
• A vector basemap layer created using a BasemapStyle.

If the URL represents a PortalItem that can be used to download vector tiles or style resources, the portalItem property will be populated when the task is loaded.

[explicit] ExportVectorTilesTask::ExportVectorTilesTask(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Constructs an ExportVectorTilesTask with a url to a vector tile service, a credential for the secured service, and an optional parent.

The vector tile service must be enabled for export or the task will fail to load. A vector tile service URL ends with VectorTileServer.

[explicit] ExportVectorTilesTask::ExportVectorTilesTask(Esri::ArcGISRuntime::PortalItem *portalItem, QObject *parent = nullptr)

Initialize an export vector tiles task with a portal item of type PortalItemType::VectorTileService.

• portalItem - A portal item instance.
• parent - The optional parent QObject.

If the portal item is not of type PortalItemType::VectorTileService the task will fail to load. The portal item will reference a vector tile service and once the task is loaded the property url will be populated to the backing service. This portal item can also contain custom style resources. See hasStyleResources which can additionally be exported as ItemResourceCache.

[override virtual] ExportVectorTilesTask::~ExportVectorTilesTask()

Destructor.

[override virtual, since Esri::ArcGISRuntime 100.10] QString ExportVectorTilesTask::apiKey() const

Reimplements: ApiKeyResource::apiKey() const.

Returns the API key allows your app to access ArcGIS location services and private portal items.

An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the `Generate API keys` privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.

Note: An API key created with a referrer is not supported. If you need service requests to include the referrer, use the SDK's functionality to intercept the request and add an HTTP referer header.

In addition to setting an ArcGISRuntimeEnvironment::apiKey at a global level for your application, you can set it on any class that implements ApiKeyResource. This overrides the ArcGISRuntimeEnvironment::apiKey and enables more granular usage telemetry and management of ArcGIS location resources used by your app.

Classes that expose an API key property by implementing ApiKeyResource include:

• ArcGISSceneLayer
• ArcGISTiledLayer
• ArcGISVectorTiledLayer
• Basemap
• BasemapStylesService
• ClosestFacilityTask
• ExportTileCacheTask
• ExportVectorTilesTask
• GeodatabaseSyncTask
• LocatorTask
• RouteTask
• ServiceAreaTask
• ServiceFeatureTable

For more information, see API key authentication and Types of authentication.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also setApiKey().

[override virtual] void ExportVectorTilesTask::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

[since Esri::ArcGISRuntime 200.2] QFuture<Esri::ArcGISRuntime::ExportVectorTilesParameters> ExportVectorTilesTask::createDefaultExportVectorTilesParametersAsync(const Esri::ArcGISRuntime::Geometry &areaOfInterest, double maxScale)

Returns the default parameters for the export vector tile task.

• areaOfInterest - a Geometry specifying the area of vector tiles to be exported. Must not be empty.
• maxScale - the map scale '1:max_scale' which determines how far in to export the vector tiles. Set the value to 0 to include all levels of detail in the service.

This function is asynchronous because it makes use of the service metadata to populate the ExportVectorTilesParameters object. Calling this function will trigger the ExportVectorTilesTask to be loaded, unless it is already loaded.

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.

A max_scale of 0 will include all levels of detail of the service. Be careful when you provide a large area of interest or a small max_scale value as this could result in a large number of tiles being requested. If the number of tiles requested exceeds the service's maximum export tile count the ExportVectorTilesJob will fail.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[override virtual] Esri::ArcGISRuntime::Credential *ExportVectorTilesTask::credential() const

Reimplements: RemoteResource::credential() const.

Returns the security credential used to access the tiled ArcGIS map service.

This is only applicable if using a service that is secured.

[signal] void ExportVectorTilesTask::doneLoading(const Esri::ArcGISRuntime::Error &loadError)

Signal emitted when this object is done loading.

• loadError - Details about any error that may have occurred.

If there is a load error, it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

Esri::ArcGISRuntime::ExportVectorTilesJob *ExportVectorTilesTask::exportStyleResourceCache(const QString &itemResourcePath)

Returns a new export vector tiles job that will download a custom style from a portal item as an item resource cache.

• itemResourcePath - The file path where the vector style file will be saved on disk.

The job will return the item resource cache without a vector tile cache. This is useful when a number of different styles are applied to the same underlying vector tile service. This avoids exporting multiple copies of the same tiles.

Esri::ArcGISRuntime::ExportVectorTilesJob *ExportVectorTilesTask::exportVectorTiles(const Esri::ArcGISRuntime::ExportVectorTilesParameters &parameters, const QString &vectorTileCachePath)

Returns a new export vector tiles job that can be used to generate and download a vector tile package containing the vector tiles specified by the parameters (ExportVectorTilesParameters).

• parameters - specifying which tiles to include in the vector tile package.
• vectorTileCachePath - The file path where the vector tiles will be saved on disk, including the desired file name ending with the .vtpk file extension.

Esri::ArcGISRuntime::ExportVectorTilesJob *ExportVectorTilesTask::exportVectorTiles(const Esri::ArcGISRuntime::ExportVectorTilesParameters &parameters, const QString &vectorTileCachePath, const QString &itemResourcePath)

Returns a new export vector tiles job that can be used to generate and download a vector tile package and return a custom style as an item resource cache.

• parameters - specifying which tiles to include in the vector tile package.
• vectorTileCachePath - The file path where the vector tiles will be saved on disk, including the desired file name ending with the .vtpk file extension.
• itemResourcePath - The directory path where the style file will be saved on disk.

bool ExportVectorTilesTask::hasStyleResources() const

Returns if the task's portal item has any associated style resources that override the default style of the vector tile service.

This property will be set to true if the export vector tile task has been loaded and the task's portal item has style resources. The portal item's style resources override the default style of the vector tile service and can be exported as ItemResourceCache.

[override virtual] void ExportVectorTilesTask::load()

Reimplements: Loadable::load().

Loads the metadata for the object asynchronously.

Loads the metadata if the object is not loaded.

See Loadable.

[override virtual] Esri::ArcGISRuntime::Error ExportVectorTilesTask::loadError() const

Reimplements: Loadable::loadError() const.

Returns the load error.

See Loadable.

See also Error.

[override virtual] Esri::ArcGISRuntime::LoadStatus ExportVectorTilesTask::loadStatus() const

Reimplements: Loadable::loadStatus() const.

Returns the load status.

See Loadable.

See also LoadStatus.

[signal] void ExportVectorTilesTask::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the load status changes for this object.

• loadStatus - The LoadStatus.

See also Loadable.

Esri::ArcGISRuntime::PortalItem *ExportVectorTilesTask::portalItem() const

Returns the task's portal item which must be of type PortalItemType::VectorTileService.

This property can only be set when the task is load status LoadStatus::NotLoaded or LoadStatus::FailedToLoad If the portal item is not of type PortalItemType::VectorTileService the task will fail to load. A vector tile service can be referenced by an item in a portal of type PortalItemType::VectorTileService. This item can also contain custom style resources see hasStyleResources which can be exported as ItemResourceCache.

[override virtual] Esri::ArcGISRuntime::RequestConfiguration ExportVectorTilesTask::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this task.

See also setRequestConfiguration().

[override virtual] void ExportVectorTilesTask::retryLoad()

Reimplements: Loadable::retryLoad().

Loads or retries loading metadata for the object asynchronously.

Will retry loading the metadata if the object is failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.

See Loadable.

[override virtual, since Esri::ArcGISRuntime 100.10] void ExportVectorTilesTask::setApiKey(const QString &apiKey)

Reimplements: ApiKeyResource::setApiKey(const QString &apiKey).

Sets the API key to apiKey.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also apiKey().

[override virtual] void ExportVectorTilesTask::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets configuration parameters used for network requests sent by this task to requestConfiguration.

See also requestConfiguration().

Esri::ArcGISRuntime::VectorTileSourceInfo ExportVectorTilesTask::sourceInfo() const

Returns the VectorTileSourceInfo representing the source metadata for a vector tile service.

[override virtual] QUrl ExportVectorTilesTask::url() const

Reimplements: RemoteResource::url() const.

Returns the URL for exporting vector tiles.

This property can be the URL of:

• A vector tile server that ends in "VectorTileServer" and is the REST endpoint used to export vector tile packages. The vector tile service must be enabled for export or the task will fail to load.
• A portal item for a vector tile service or a vector tiled layer with a custom style applied.
• A vector basemap layer created using a BasemapStyle.

If the URL represents a PortalItem that can be used to download vector tiles or style resources, the portalItem property will be populated when the task is loaded.