RasterPyramids class final
Provides access to pyramid information and pyramid management operations for a raster.
This object is owned by a Raster and exposes the current pyramid state for that raster. Use Raster.pyramids to get the instance associated with a raster. If the raster does not support pyramids, Raster.pyramids is null.
Pyramids for a raster can be embedded within the raster file or stored in a separate pyramid file (.ovr). This object can build and delete pyramids stored in a separate pyramid file when the raster source supports those operations.
To determine whether pyramids can be built, check that both RasterPyramids.pyramidInfo and RasterPyramids.activeBuildOperation are null. To determine whether pyramids can be deleted, check that RasterPyramids.pyramidInfo is not null, RasterPyramidInfo.isEmbedded is false, and RasterPyramids.activeBuildOperation is null. These checks describe the current pyramid state and whether a build is in progress; they do not guarantee that a build or delete request will succeed.
- Implemented types
Properties
- activeBuildOperation → BuildRasterPyramidsOperation?
-
The pyramid build operation currently running for the owning raster.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
onActiveBuildOperationChanged
→ Stream<
BuildRasterPyramidsOperation?> -
Called when the value of RasterPyramids.activeBuildOperation changes.
no setter
- pyramidInfo → RasterPyramidInfo?
-
Information about the raster's pyramid set.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
buildPyramids(
BuildRasterPyramidsParameters parameters) → BuildRasterPyramidsOperation - Starts building pyramids stored in a pyramid file (.ovr) for the owning raster.
-
deletePyramids(
) → void - Deletes pyramids stored in a pyramid file (.ovr) for the owning raster.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited