Class: QgsLegendModel

Item model implementation based on layer tree model for layout legend.

Overrides some functionality of QgsLayerTreeModel to better fit the needs of layout legends.

Class Hierarchy

Base classes

QgsLayerTreeModel	A model representing the layer tree, including layers and groups of layers.
QAbstractItemModel
QObject

Methods

clearCachedData

Clears any previously cached data for the specified node.

Signals

refreshLegend

Emitted to refresh the legend.

class qgis.core.QgsLegendModel

Bases: QgsLayerTreeModel

__init__(rootNode: QgsLayerTree | None, parent: QObject | None = None, layout: QgsLayoutItemLegend | None = None)

Construct the model based on the given layer tree

Parameters:

• rootNode (Optional[QgsLayerTree])

• parent (Optional[QObject] = None)

• layout (Optional[QgsLayoutItemLegend] = None)

__init__(rootNode: QgsLayerTree | None, layout: QgsLayoutItemLegend | None)

Alternative constructor.

Parameters:

• rootNode (Optional[QgsLayerTree])

• layout (Optional[QgsLayoutItemLegend])

clearCachedData(self, node: QgsLayerTreeNode | None)

Clears any previously cached data for the specified node.

Added in version 3.14.

Parameters:

node (Optional[QgsLayerTreeNode])

signal refreshLegend

Emitted to refresh the legend.

Added in version 3.10.