Class: QgsRuleBasedRendererModel

class qgis.gui.QgsRuleBasedRendererModel

Bases: PyQt5.QtCore.QAbstractItemModel

Tree model for the rules:

(invalid) == root node +— top level rule +— top level rule

QgsRuleBasedRendererModel(renderer: Optional[QgsRuleBasedRenderer], parent: Optional[QObject], screen: Optional[QScreen] = None) Constructor for QgsRuleBasedRendererModel, for the specified renderer.

Methods

beginInsertColumns

beginInsertRows

beginMoveColumns

beginMoveRows

beginRemoveColumns

beginRemoveRows

beginResetModel

changePersistentIndex

changePersistentIndexList

childEvent

clearFeatureCounts

columnCount

param a0:

connectNotify

createIndex

customEvent

data

param index:

decodeData

disconnectNotify

dropMimeData

param data:

encodeData

endInsertColumns

endInsertRows

endMoveColumns

endMoveRows

endRemoveColumns

endRemoveRows

endResetModel

finishedAddingRules

flags

param index:

headerData

param section:

index

param row:

insertRule

param parent:

isSignalConnected

mimeData

param indexes:

mimeTypes

rtype:

List[str]

parent

param index:

persistentIndexList

receivers

removeRows

param row:

removeRule

param index:

resetInternalData

rowCount

param parent:

ruleForIndex

param index:

sender

senderSignalIndex

setData

param index:

setSymbol

Sets the symbol for the rule at the specified index.

supportedDropActions

rtype:

Qt.DropActions

timerEvent

updateRule

param parent:

willAddRules

param parent:

beginInsertColumns(self, parent: QModelIndex, first: int, last: int)
beginInsertRows(self, parent: QModelIndex, first: int, last: int)
beginMoveColumns(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationColumn: int) bool
beginMoveRows(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationRow: int) bool
beginRemoveColumns(self, parent: QModelIndex, first: int, last: int)
beginRemoveRows(self, parent: QModelIndex, first: int, last: int)
beginResetModel(self)
changePersistentIndex(self, from_: QModelIndex, to: QModelIndex)
changePersistentIndexList(self, from_: Iterable[QModelIndex], to: Iterable[QModelIndex])
childEvent(self, a0: QChildEvent | None)
clearFeatureCounts(self)
columnCount(self, a0: QModelIndex = QModelIndex()) int
Parameters:

a0 (QModelIndex = QModelIndex())

Return type:

int

connectNotify(self, signal: QMetaMethod)
createIndex(self, row: int, column: int, object: Any = None) QModelIndex
customEvent(self, a0: QEvent | None)
data(self, index: QModelIndex, role: int = Qt.DisplayRole) Any
Parameters:
  • index (QModelIndex)

  • role (int = Qt.DisplayRole)

Return type:

Any

decodeData(self, row: int, column: int, parent: QModelIndex, stream: QDataStream) bool
disconnectNotify(self, signal: QMetaMethod)
dropMimeData(self, data: QMimeData | None, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) bool
Parameters:
  • data (Optional[QMimeData])

  • action (Qt.DropAction)

  • row (int)

  • column (int)

  • parent (QModelIndex)

Return type:

bool

encodeData(self, indexes: Iterable[QModelIndex], stream: QDataStream)
endInsertColumns(self)
endInsertRows(self)
endMoveColumns(self)
endMoveRows(self)
endRemoveColumns(self)
endRemoveRows(self)
endResetModel(self)
finishedAddingRules(self)
flags(self, index: QModelIndex) Qt.ItemFlags
Parameters:

index (QModelIndex)

Return type:

Qt.ItemFlags

headerData(self, section: int, orientation: Qt.Orientation, role: int = Qt.DisplayRole) Any
Parameters:
  • section (int)

  • orientation (Qt.Orientation)

  • role (int = Qt.DisplayRole)

Return type:

Any

index(self, row: int, column: int, parent: QModelIndex = QModelIndex()) QModelIndex
Parameters:
  • row (int)

  • column (int)

  • parent (QModelIndex = QModelIndex())

Return type:

QModelIndex

insertRule(self, parent: QModelIndex, before: int, newrule: QgsRuleBasedRenderer.Rule | None)
Parameters:
isSignalConnected(self, signal: QMetaMethod) bool
mimeData(self, indexes: Iterable[QModelIndex]) QMimeData | None
Parameters:

indexes (Iterable[QModelIndex])

Return type:

Optional[QMimeData]

mimeTypes(self) List[str]
Return type:

List[str]

parent(self, index: QModelIndex) QModelIndex
Parameters:

index (QModelIndex)

Return type:

QModelIndex

persistentIndexList(self) List[QModelIndex]
receivers(self, signal: PYQT_SIGNAL) int
removeRows(self, row: int, count: int, parent: QModelIndex = QModelIndex()) bool
Parameters:
  • row (int)

  • count (int)

  • parent (QModelIndex = QModelIndex())

Return type:

bool

removeRule(self, index: QModelIndex)
Parameters:

index (QModelIndex)

resetInternalData(self)
rowCount(self, parent: QModelIndex = QModelIndex()) int
Parameters:

parent (QModelIndex = QModelIndex())

Return type:

int

ruleForIndex(self, index: QModelIndex) QgsRuleBasedRenderer.Rule | None
Parameters:

index (QModelIndex)

Return type:

Optional[QgsRuleBasedRenderer.Rule]

sender(self) QObject | None
senderSignalIndex(self) int
setData(self, index: QModelIndex, value: Any, role: int = Qt.EditRole) bool
Parameters:
  • index (QModelIndex)

  • value (Any)

  • role (int = Qt.EditRole)

Return type:

bool

setSymbol(self, index: QModelIndex, symbol: QgsSymbol | None)

Sets the symbol for the rule at the specified index. Ownership of the symbols is transferred to the renderer.

Added in version 3.10.

Parameters:
  • index (QModelIndex)

  • symbol (Optional[QgsSymbol])

supportedDropActions(self) Qt.DropActions
Return type:

Qt.DropActions

timerEvent(self, a0: QTimerEvent | None)
updateRule(self, parent: QModelIndex, row: int)
updateRule(self, index: QModelIndex) None
Parameters:
  • parent (QModelIndex)

  • row (int)

willAddRules(self, parent: QModelIndex, count: int)
Parameters:
  • parent (QModelIndex)

  • count (int)