Export
A job to download a vector tile cache (.vtpk) with its default style or with its associated custom style resources. Alternatively, the job can download only the custom style resources. To make an ExportVectorTilesJob, you must create an ExportVectorTilesTask, as follows:
Instantiate the ExportVectorTilesTask with a URL to an ArcGIS vector tile service, if you want to download the vector tile package and its default style resources.
Instantiate the ExportVectorTilesTask with a portal item that represents an ArcGIS vector tiled layer, if you want to download the vector tile package and its custom style resources or if you only want to download custom style resources.
After loading the ExportVectorTilesTask, call ExportVectorTilesTask.createDefaultExportVectorTilesParameters to obtain its default ExportVectorTilesParameters. Specify the area of interest and the maximum scale. Be aware that there will no tiles when the map is zoomed in beyond this maximum scale. If you set the maximum scale to 0, the export will include all levels of detail in the service. You can also examine the ExportVectorTilesTask.hasStyleResources to determine if the vector tile service has any custom style resources that override the default style.
Next, you can create the ExportVectorTilesJob, as follows:
To download a vector tile package and its default style resources, call ExportVectorTilesTask.createExportVectorTilesJob.
To download a vector tile package and its custom style resources, call ExportVectorTilesTask.createExportVectorTilesJob.
To download custom style resources associated with the task's vector tile service, call ExportVectorTilesTask.createExportStyleResourceCacheJob.
To export the vector tiles and/or custom styles, start the ExportVectorTilesJob, monitor progress, and examine the ExportVectorTilesJob.result when the job completes successfully.
Use the ExportVectorTilesResult.vectorTileCache in the ArcGISVectorTiledLayer.ArcGISVectorTiledLayer to create an ArcGIS vector tiled layer. If you downloaded a custom style, use the ExportVectorTilesResult.itemResourceCache in the ArcGISVectorTiledLayer.ArcGISVectorTiledLayer.
Since
200.1.0
Properties
The path that the downloaded vector tile style is saved to. If this job was created with ExportVectorTilesTask.createExportVectorTilesJob, this will be an empty string.
The parameters used to create this job.
The path that the downloaded vector tile cache is saved to. The path will have the file extension .vtpk. If this job was created with ExportVectorTilesTask.createExportStyleResourceCacheJob, this will be an empty string.
Inherited properties
Inherited functions
Cancels this Job and waits for any asynchronous, server-side operations to be canceled. The job is canceled and will result in a JobStatus.Failed status after all cancellation tasks have completed. For jobs running on a server, a cancel request is sent for the associated Job.serverJobId. You should always cancel unneeded jobs (for example when exiting your app) to avoid placing unnecessary load on the server. Examples of server-side jobs include:
Initiates a request to check the server status. If the job is polling the server for status and is in a time gap, then calling this method will ensure a request is sent right away. The result can be false if the job is not checking server status for example if the job status is paused or uploading.
Suspends until this job has completed. Calling this function does not start the job. In order to start the job call start