EstimateTileCacheSizeJob class final
A job that estimates the size of a tile cache (.tpk or .tpkx) that can be exported from a map or image service.
Use the EstimateTileCacheSizeJob to get the approximate size of a tile cache for a specific set of ExportTileCacheParameters. Note that time required to create a tile cache varies depending on the extent requested, the number of levels requested, the network connection speed, and so on. When planning a large offline data capture event, generate a smaller tile cache to get an idea of how long caching will take.
To make an EstimateTileCacheSizeJob, use the ExportTileCacheTask as follows:
- Confirm that the map or image service can export tiles by checking ArcGISMapServiceInfo.exportTileCacheCompactV2Allowed for the compact version 2 format (.tpkx) and ArcGISMapServiceInfo.exportTilesAllowed for the legacy format (.tpk).
- Construct and load the ExportTileCacheTask with the map or image service.
- Create a Geometry to define the area of interest that you wish to take offline.
- Obtain the default ExportTileCacheParameters by calling ExportTileCacheTask.createDefaultExportTileCacheParameters with the area of interest and a minimum and maximum scale for the tile cache.
- Use the ExportTileCacheParameters to create an EstimateTileCacheSizeJob by calling ExportTileCacheTask.estimateTileCacheSize.
Start the EstimateTileCacheSizeJob and monitor progress. Upon completion, the job's EstimateTileCacheSizeResult provides an estimate of the number and size of files in the tile cache.
See the Job class for full information on how to work with jobs.
- Inheritance
-
- Object
- Job<
EstimateTileCacheSizeResult> - EstimateTileCacheSizeJob
Properties
- error → ArcGISException?
-
Contains an error if the job fails, otherwise null.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
messages
→ List<
JobMessage> -
The job's messages.
no setterinherited
-
onJobDone
→ Stream<
void> -
Sets the function that will be called when the job is done.
no setterinherited
-
onMessageAdded
→ Stream<
JobMessage> -
Indicates that a new
JobMessagewas added to Job.messages.no setterinherited -
onProgressChanged
→ Stream<
int> -
Sets the function that will be called when the job's progress has changed.
no setterinherited
-
onStatusChanged
→ Stream<
JobStatus> -
Indicates that the Job.status property has changed.
no setterinherited
- progress → int
-
The current progress of the job as a percentage complete.
no setterinherited
- result → EstimateTileCacheSizeResult?
-
For a successfully completed job the result returns an estimate of the
tile cache size. Otherwise null is returned.
no setteroverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- serverJobId → String
-
The server job Id of the job.
no setterinherited
- status → JobStatus
-
The status of the job.
no setterinherited
Methods
-
cancel(
) → Future< bool> -
Cancels this Job and waits for any asynchronous, server-side operations
to be canceled.
inherited
-
checkStatus(
) → Future< bool> -
Initiates a request to check the server status.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pause(
) → bool -
Pauses the job.
inherited
-
run(
) → Future< EstimateTileCacheSizeResult> -
Starts the job and returns a Future that completes with either the result
of the job or an error if the job did not finish successfully.
inherited
-
start(
) → bool -
Starts the job if the job is not started or paused.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a JSON representation of this Object in the data type used by jsonDecode.
inherited
-
toJsonString(
) → String -
Returns a JSON representation of this Object as a String.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited