Class: QgsLayerTreeProxyModel

The QgsLayerTreeProxyModel class is a proxy model for QgsLayerTreeModel, supports private layers and text filtering.

Added in version 3.18.

Class Hierarchy

Base classes

QSortFilterProxyModel
QAbstractProxyModel
QAbstractItemModel
QObject

Methods

hideValidLayers	Returns if valid layers should be hidden (i.e. only invalid layers are shown).
setFilterText	Sets filter to filterText.
setHideValidLayers	Sets whether valid layers should be hidden (i.e. only invalid layers are shown).
setShowPrivateLayers	Determines if private layers are shown.
showPrivateLayers	Returns if private layers are shown.

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

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