arcgis-maps-kotlin/com.arcgismaps.raster/BuildRasterPyramidsOperation

BuildRasterPyramidsOperation

An operation that builds pyramids for a raster. A BuildRasterPyramidsOperation is returned by RasterPyramids.buildPyramids. While the build is in progress, the same operation is also available from RasterPyramids.activeBuildOperation. Use this object to observe progress, request cancellation, and await the pyramid information produced by the build.

When the operation completes successfully, BuildRasterPyramidsOperation.result returns information about the pyramid set that was built, and RasterPyramids.pyramidInfo is refreshed with that same information.

Since

300.1.0

Properties

progress

val progress: StateFlow<Double>

The approximate fraction of pyramid build work completed. Progress is reported as a value from 0.0 to 1.0 inclusive. A value of 0.0 indicates that no progress has been made, and a value of 1.0 indicates that the build completed successfully.

Functions

cancel

fun cancel()

Requests cancellation of the pyramid build operation. Cancellation is cooperative. After cancellation is requested, the operation may continue until the executing code observes the request. If cancellation is observed, BuildRasterPyramidsOperation.result reports cancellation.

result

suspend fun result(): Result<RasterPyramidInfo>

Suspends and returns a result when the pyramid build operation has completed. This method does not start the operation. It suspends and resumes when the pyramid build operation completes. If the operation has already completed, the method returns the operation's result or error. If the operation completes successfully, the method returns information about the pyramid set that was built. If the operation fails or is canceled, the returned Result reports the corresponding error.