Skip To Content ArcGIS for Developers Sign In Dashboard

RGBRenderer QML Type

A RGB composite raster renderer. More...

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




Detailed Description

A RGB composite stretch renderer can help visualize raster data using RasterLayer.

It is similar to StretchRenderer but allows you to combine bands as red, green, blue composites. This renderer can be used for viewing color aerial photography, which is a three-band raster dataset, or to display different combinations of bands when working with multi-band raster datasets, such as satellite or aerial imagery.

Note: This type is immutable once created. Once the renderer is created and applied to a layer, none of its properties can be changed. Instead, create a new renderer and apply it to the layer.

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.

Property Documentation

bandIndexes : list<int>

The indexes of bands of a multi-band raster dataset that the renderer is based on.

The band specified by the 0th index is used as the Red band, 1st index as the Green band, and 2nd index as the Blue band.

panchromaticRaster : Raster

The high-resolution panchromatic raster to use as a basis for panchoromatic sharpening.

Pan-sharpening uses a higher-resolution panchromatic image (or raster band) to fuse with a lower-resolution multi-band raster dataset. The result produces a multi-band raster dataset with the resolution of the panchromatic raster where the two rasters fully overlap.

Note: Please see the ArcGIS Desktop documentation for further details.

pansharpenType : Enums.PansharpenType

The type of panchromatic sharpening method that is applied.

See also Enums.PansharpenType.

weights : list<double>

The weights to use in the panchromatic sharpening method.

Each of method uses different models to improve the spatial resolution while maintaining the color, and some are adjusted to include a weighting so that a fourth band can be included (such as the near-infrared band available in many multispectral image sources). By adding the weighting and enabling the infrared component, the visual quality in the output colors is improved.

Signal Documentation


Emitted when the bandIndexes property changes.

Note: The corresponding handler is onBandIndexesChanged.


Emitted when the panchromaticRaster property changes.

Note: The corresponding handler is onPanchromaticRasterChanged.


Emitted when the pansharpenType property changes.

Note: The corresponding handler is onPansharpenTypeChanged.


Emitted when the weights property changes.

Note: The corresponding handler is onWeightsChanged.

Feedback on this topic?