Class: QgsRasterAttributeTableModel

A model which represents a QgsRasterAttributeTable.

Added in version 3.30.

Class Hierarchy

Base classes

QAbstractTableModel
QAbstractItemModel
QObject

class qgis.gui.QgsRasterAttributeTableModel

Bases: QAbstractTableModel

__init__(rat: QgsRasterAttributeTable | None, parent: QObject | None = None)

Creates a new QgsRasterAttributeTableModel from raster attribute table rat and optional parent.

Parameters:

• rat (Optional[QgsRasterAttributeTable])

• parent (Optional[QObject] = None)

editable(self) → bool

Returns true if the Raster Attribute Table is editable.

Return type:

bool

hasColor(self) → bool

Returns True if the Raster Attribute Table has color information.

Return type:

bool

hasRamp(self) → bool

Returns True if the Raster Attribute Table has ramp information.

Return type:

bool

headerNames(self) → List[str]

Returns all the header names, including the “virtual” color header if the Raster Attribute Table has color or ramp.

Return type:

List[str]

headerTooltip(self, section: int) → str

Returns the tooltip for the given section.

Parameters:

section (int)

Return type:

str

insertColor(self, position: int)

Create RGBA fields and inserts them at position, optionally reporting any error in errorMessage, returns True on success.

Parameters:

position (int) -> (bool)

insertField(self, position: int, name: str | None, usage: Qgis.RasterAttributeTableFieldUsage, type: QMetaType.Type)

Inserts a field at the given position.

Parameters:

• name (Optional[str]) – field name

• usage (Qgis.RasterAttributeTableFieldUsage) – field usage

• type (QMetaType.Type) -> (bool) – field type

• position (int) – insertion point (before)

Returns:

• true on success

• errorMessage: error message

insertField(self, position: int, name: Optional[str], usage: Qgis.RasterAttributeTableFieldUsage, type: QVariant.Type) -> (bool, Optional[str]) Inserts a field at the given position.

Parameters:

• name – field name

• usage – field usage

• type – field type

• position – insertion point (before)

Returns:

• true on success

• errorMessage: error message

Deprecated since version 3.38: Use the method with a QMetaType.Type argument instead.

insertRamp(self, position: int)

Create RGBA minimum and maximum fields and inserts them at position, optionally reporting any error in errorMessage, returns True on success.

Parameters:

position (int) -> (bool)

insertRow(self, position: int, rowData: Iterable[Any])

Inserts a new row before position, optionally reporting any error in errorMessage, returns True on success.

Parameters:

• position (int)

• rowData (Iterable[Any]) -> (bool)

isDirty(self) → bool

Returns True if the Raster Attribute Table was modified since it was last saved or read.

Return type:

bool

isValid(self)

Checks if the Raster Attribute Table is valid, optionally returns validation errors in errorMessage.

removeColorOrRamp(self)

Removes all color or ramp information, optionally reporting any error in errorMessage, returns True on success.

removeField(self, position: int)

Remove the field at given position, optionally reporting any error in errorMessage, returns True on success.

Parameters:

position (int) -> (bool)

removeRow(self, position: int)

Removes the row at position, optionally reporting any error in errorMessage, returns True on success.

Parameters:

position (int) -> (bool)

setEditable(self, editable: bool)

Sets the Raster Attribute Table editable state to editable.

Parameters:

editable (bool)