ExportTileCacheTask class final
A task used to export a tile cache (.tpk or .tpkx). Use this in conjunction with a map or image service to generate and download tile packages.
To confirm whether a map or image service supports exporting tiles, check:
- ArcGISMapServiceInfo.exportTilesAllowed property for the legacy compact format (.tpk)
- ArcGISMapServiceInfo.exportTileCacheCompactV2Allowed property for the compact version 2 format (.tpkx)
See TileCache for information on creating a layer from a local tile cache.
When using Esri provided image basemaps (such as the World Imagery basemap, see BasemapStyle.arcGISImagery) an alternative service which supports exporting tiles may be used instead. For example, the World Imagery Service (https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer) will be exported using a corresponding export-enabled service (https://tiledbasemaps.arcgis.com/arcgis/rest/services/World_Imagery/MapServer).
Similarly, when using elevation data from Esri (such as Terrain 3D), an
alternative service
that supports exporting tiles may be used instead. For example, the Terrain
3D
(https://elevation3d.arcgis.com/ArcGIS/rest/services/WorldElevation3D/Terrain3D/ImageServer)
will be exported using a corresponding export-enabled service
(https://tiledbasemaps.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer).
The resulting tile cache can then be used to create an offline
ArcGISTiledElevationSource in a scene.
Note that these export-enabled services are not intended for use as an online basemap or elevation source, and should only be used for exporting tiles for offline use. The export-enabled services require authentication to export tiles.
- Implemented types
- Mixed in types
Constructors
- ExportTileCacheTask({required Uri uri})
-
Create an export tile cache task from a URL.
factory
Properties
- apiKey ↔ String
-
The API key allows your app to access ArcGIS location services and private
portal items.
getter/setter pairoverride
- arcGISMapServiceInfo → ArcGISMapServiceInfo?
-
The task's ArcGISMapServiceInfo
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- loadError → ArcGISException?
-
The load error.
no setterinherited
- loadStatus → LoadStatus
-
The load status.
no setterinherited
-
onLoadStatusChanged
→ Stream<
LoadStatus> -
A stream that reports changes to the
LoadStatus.no setterinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uri → Uri
-
The task's service URL.
no setter
Methods
-
cancelLoad(
) → void -
Cancels loading metadata for the object.
inherited
-
createDefaultExportTileCacheParameters(
{required Geometry areaOfInterest, required double minScale, required double maxScale}) → Future< ExportTileCacheParameters> -
Creates and returns a Future of
ExportTileCacheParameters. -
createDefaultExportTileCacheParametersCancelable(
{required Geometry areaOfInterest, required double minScale, required double maxScale}) → CancelableOperation< ExportTileCacheParameters> - Cancelable version of createDefaultExportTileCacheParameters. See that method for more information.
-
estimateTileCacheSize(
{required ExportTileCacheParameters parameters}) → EstimateTileCacheSizeJob - Return a new estimate tile cache size job.
-
exportTileCache(
{required ExportTileCacheParameters parameters, required Uri downloadFileUri}) → ExportTileCacheJob - Return a new export tile cache job.
-
load(
) → Future< void> -
Loads the metadata for the object asynchronously.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
retryLoad(
) → Future< void> -
Loads or retries loading metadata for the object asynchronously.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited