Skip To Content ArcGIS for Developers Sign In Dashboard

Raster Class


Represents raster data that can be rendered using a RasterLayer. More...

Header: #include <Raster>
Since: Esri::ArcGISRuntime 100.0
Inherits: Object and Loadable
Inherited By:

Esri::ArcGISRuntime::GeoPackageRaster, Esri::ArcGISRuntime::ImageServiceRaster, and Esri::ArcGISRuntime::MosaicDatasetRaster

Public Functions

Raster(const QString &path, QObject *parent = nullptr)
Raster(RasterFunction *rasterFunction, QObject *parent = nullptr)
QString path() const
RasterFunction *rasterFunction() const
RasterType rasterType() const

Reimplemented Public Functions

virtual void cancelLoad()
virtual void load()
virtual Error loadError() const
virtual LoadStatus loadStatus() const
virtual void retryLoad()


void doneLoading(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

Represents raster data that can be rendered using a RasterLayer.

A raster consists of a matrix of cells (or pixels) organized into rows and columns (or a grid) where each cell contains a value representing information, such as temperature. Rasters are digital aerial photographs, imagery from satellites, digital pictures, or even scanned maps.

It can be created from a raster file on device or from a raster function.

Supported Raster formats include:

  • CIB1, 5, 10
  • DTED0, 1, 2
  • GeoTIFF
  • HFA
  • HRE
  • IMG
  • JPEG
  • JPEG 2000
  • NITF
  • PNG
  • RPF
  • SRTM1, 2
  • Mosaic Dataset in SQLite (read-only)

Learn more about rasters from the ArcGIS Desktop documentation.

See also RasterLayer.

Member Function Documentation

Raster::Raster(const QString &path, QObject *parent = nullptr)

Constructor that takes a path to a local raster file and an optional parent.

Raster::Raster(RasterFunction *rasterFunction, QObject *parent = nullptr)

Constructor that takes a rasterFunction and an optional parent.



[virtual] void Raster::cancelLoad()

Reimplemented from Loadable::cancelLoad().

See Loadable.

[signal] void Raster::doneLoading(Esri::ArcGISRuntime::Error loadError)

Signal emitted when this object is done loading.

  • loadError - Details about any error that may have occurred.

Note: If there is a load error it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

[virtual] void Raster::load()

Reimplemented from Loadable::load().

See Loadable.

[virtual] Error Raster::loadError() const

Reimplemented from Loadable::loadError().

See Loadable.

[virtual] LoadStatus Raster::loadStatus() const

Reimplemented from Loadable::loadStatus().

See Loadable.

[signal] void Raster::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the loadStatus changes for this object.

See also Loadable.

QString Raster::path() const

Returns the path to the raster file.

RasterFunction *Raster::rasterFunction() const

Returns the raster function used to create this raster.

RasterType Raster::rasterType() const

Returns the raster type.

[virtual] void Raster::retryLoad()

Reimplemented from Loadable::retryLoad().

See Loadable.

Feedback on this topic?