Class: QgsLayerTreeProxyModel

A proxy model for QgsLayerTreeModel, supporting private layers and text filtering.

Added in version 3.18.

Class Hierarchy

Base classes

QSortFilterProxyModel
QAbstractProxyModel
QAbstractItemModel
QObject

class qgis.gui.QgsLayerTreeProxyModel

Bases: QSortFilterProxyModel

__init__(treeModel: QgsLayerTreeModel | None, parent: QObject | None)

Constructs QgsLayerTreeProxyModel with source model treeModel and a parent

Parameters:

• treeModel (Optional[QgsLayerTreeModel])

• parent (Optional[QObject])

hideValidLayers(self) → bool

Returns if valid layers should be hidden (i.e. only invalid layers are shown).

See also

setHideValidLayers()

Added in version 3.38.

Return type:

bool

virtual nodeShown(self, node: QgsLayerTreeNode | None) → bool

Returns True if the specified node should be shown.

Added in version 4.0.

Parameters:

node (Optional[QgsLayerTreeNode])

Return type:

bool

setFilterText(self, filterText: str | None = '')

Sets filter to filterText.

Parameters:

filterText (Optional[str] = '')

setHideValidLayers(self, hideValid: bool)

Sets whether valid layers should be hidden (i.e. only invalid layers are shown).

See also

setHideValidLayers()

Added in version 3.38.

Parameters:

hideValid (bool)

setShowPrivateLayers(self, showPrivate: bool)

Determines if private layers are shown.

Parameters:

showPrivate (bool)

showPrivateLayers(self) → bool

Returns if private layers are shown.

Return type:

bool