ArcGIS Developers

Raster QML Type

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

Import Statement: import Esri.ArcGISRuntime 100.11
Since: Esri.ArcGISRuntime 100.0


Inherited By:

GeoPackageRaster, ImageServiceRaster, and MosaicDatasetRaster




Detailed Description

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.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

TypeDefault Property

See also Loadable, RasterLayer, and Loadable.

Property Documentation

error : Error

Returns the error object (read-only).

See also Loadable and Error.

loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.

loadStatus : Enums.LoadStatus

The Enums.LoadStatus of the Raster.

See also Loadable and Enums.LoadStatus.

path : url

The path to the local raster image file.

Note: You cannot set the path to the raster after the instance is already loaded.

[default] rasterFunction : RasterFunction

The raster function used to construct this Raster.

rasterType : Enums.RasterType

Returns the Raster type (read-only).

This property was introduced in Esri.ArcGISRuntime 100.1.

See also Enums.RasterType.

Signal Documentation


Emitted when the loadError property of this Raster changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.


Emitted when the loadStatus property changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.


Emitted when the path property changes.

Note: The corresponding handler is onPathChanged.


Emitted when the path or rasterFunction properties change.

Note: The corresponding handler is onRasterChanged.


Emitted when the rasterFunction property changes.

Note: The corresponding handler is onRasterFunctionChanged.

Method Documentation

void cancelLoad()

See also Loadable.

void load()

See also Loadable.

void retryLoad()

See also Loadable.

Feedback on this topic?