Class: QgsPalettedRasterRenderer

Renderer for paletted raster images.

Class Hierarchy

Base classes

QgsRasterRenderer	Raster renderer pipe that applies colors to a raster.
QgsRasterInterface	Base class for processing filters like renderers, reprojector, resampler etc.

class qgis.core.QgsPalettedRasterRenderer

Bases: QgsRasterRenderer

__init__(input: QgsRasterInterface | None, bandNumber: int, classes: Iterable[QgsPalettedRasterRenderer.Class])

Constructor for QgsPalettedRasterRenderer.

Parameters:

• input (Optional[QgsRasterInterface])

• bandNumber (int)

• classes (Iterable[QgsPalettedRasterRenderer.Class])

class Class

Bases: object

Properties of a single value class

color: QColor

label: str

value: float

class MultiValueClass

Bases: object

Properties of a multi value class: a class that contains multiple values.

Added in version 3.30.

QgsPalettedRasterRenderer.MultiValueClass(values: Iterable[Any], color: Union[QColor, Qt.GlobalColor] = QColor(), label: Optional[str] = ‘’) Constructor for MultiValueClass from a list of values

QgsPalettedRasterRenderer.MultiValueClass(a0: QgsPalettedRasterRenderer.MultiValueClass)

color: QColor

label: str

values: List[object]

band(self) → int

Returns the raster band used for rendering the raster.

Deprecated since version 3.38: Use inputBand() instead.

Return type:

int

static classDataFromFile(path: str | None) → List[QgsPalettedRasterRenderer.Class]

Opens a color table file and returns corresponding paletted renderer class data.

See also

classDataFromString()

Parameters:

path (Optional[str])

Return type:

List[QgsPalettedRasterRenderer.Class]

static classDataFromRaster(raster: QgsRasterInterface | None, bandNumber: int, ramp: QgsColorRamp | None = None, feedback: QgsRasterBlockFeedback | None = None) → List[QgsPalettedRasterRenderer.Class]

Generates class data from a raster, for the specified bandNumber. An optional color ramp can be specified to automatically assign colors from the ramp.

Parameters:

• raster (Optional[QgsRasterInterface])

• bandNumber (int)

• ramp (Optional[QgsColorRamp] = None)

• feedback (Optional[QgsRasterBlockFeedback] = None)

Return type:

List[QgsPalettedRasterRenderer.Class]

static classDataFromString(string: str | None) → List[QgsPalettedRasterRenderer.Class]

Converts a string containing a color table or class data to to paletted renderer class data.

See also

classDataFromFile()

See also

classDataToString()

Parameters:

string (Optional[str])

Return type:

List[QgsPalettedRasterRenderer.Class]

static classDataToString(classes: Iterable[QgsPalettedRasterRenderer.Class]) → str

Converts classes to a string representation, using the .clr/gdal color table file format.

See also

classDataFromString()

Parameters:

classes (Iterable[QgsPalettedRasterRenderer.Class])

Return type:

str

classes(self) → List[QgsPalettedRasterRenderer.Class]

Returns a map of value to classes (colors) used by the renderer.

Return type:

List[QgsPalettedRasterRenderer.Class]

static colorTableToClassData(table: Iterable[QgsColorRampShader.ColorRampItem]) → List[QgsPalettedRasterRenderer.Class]

Converts a raster color table to paletted renderer class data.

Parameters:

table (Iterable[QgsColorRampShader.ColorRampItem])

Return type:

List[QgsPalettedRasterRenderer.Class]

static create(elem: QDomElement, input: QgsRasterInterface | None) → QgsRasterRenderer | None

Parameters:

• elem (QDomElement)

• input (Optional[QgsRasterInterface])

Return type:

Optional[QgsRasterRenderer]

label(self, idx: float) → str

Returns optional category label

Parameters:

idx (float)

Return type:

str

multiValueClasses(self) → List[QgsPalettedRasterRenderer.MultiValueClass]

Returns a map of multi value to classes (colors) used by the renderer.

Added in version 3.30.

Return type:

List[QgsPalettedRasterRenderer.MultiValueClass]

nColors(self) → int

Returns number of colors

Return type:

int

static rasterAttributeTableToClassData(attributeTable: QgsRasterAttributeTable | None, classificationColumn: int = -1, ramp: QgsColorRamp | None = None) → List[QgsPalettedRasterRenderer.MultiValueClass]

Reads and returns classes from the Raster Attribute Table attributeTable, optionally classifying the attribute table by classificationColumn and setting the colors from ramp. The default value of -1 for the classificationColumn uses the first available value column.

Note

The method will return an empty list of classes in case the Raster Attribute Table is not thematic.

Added in version 3.30.

Parameters:

• attributeTable (Optional[QgsRasterAttributeTable])

• classificationColumn (int = -1)

• ramp (Optional[QgsColorRamp] = None)

Return type:

List[QgsPalettedRasterRenderer.MultiValueClass]

setLabel(self, idx: float, label: str | None)

Set category label

Parameters:

• idx (float)

• label (Optional[str])

setMultiValueClasses(self, classes: Iterable[QgsPalettedRasterRenderer.MultiValueClass])

Sets the multi value classes to setMultiValueClasses.

Added in version 3.30.

Parameters:

classes (Iterable[QgsPalettedRasterRenderer.MultiValueClass])

setSourceColorRamp(self, ramp: QgsColorRamp | None)

Set the source color ramp. Ownership is transferred to the renderer.

See also

sourceColorRamp()

Parameters:

ramp (Optional[QgsColorRamp])

sourceColorRamp(self) → QgsColorRamp | None

Gets the source color ramp

See also

setSourceColorRamp()

Return type:

Optional[QgsColorRamp]