Class RasterPyramids
Provides access to pyramid information and pyramid management operations for a raster.
Implements
Namespace: Esri.ArcGISRuntime.Rasters
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class RasterPyramids : INotifyPropertyChangedRemarks
This object is owned by a Raster and exposes the current pyramid state for that raster.
Use Pyramids to get the instance associated with a raster. If the raster does not
support pyramids, 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 PyramidInfo and
ActiveBuildOperation are null. To determine whether pyramids can be deleted, check that
PyramidInfo is not null,
IsEmbedded is false, and 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.
Properties
| Name | Description |
|---|---|
| ActiveBuildOperation | Gets the pyramid build operation currently running for the owning raster. |
| PyramidInfo | Gets information about the raster's pyramid set. |
Methods
| Name | Description |
|---|---|
| BuildPyramids(BuildRasterPyramidsParameters) | Starts building pyramids stored in a pyramid file (.ovr) for the owning raster. |
| DeletePyramids() | Deletes pyramids stored in a pyramid file (.ovr) for the owning raster. |
Events
| Name | Description |
|---|---|
| ActiveBuildOperationChanged | Occurs when the value of ActiveBuildOperation changes. |
| PropertyChanged | Occurs when a property value changes. |
Applies to
| Target | Versions |
|---|---|
| .NET | 300.1 |
| .NET Windows | 300.1 |
| .NET Android | 300.1 |
| .NET iOS | 300.1 |