Class: QgsLayerTreeView

Extends QTreeView and provides additional functionality when working with a layer tree.

The view updates expanded state of layer tree nodes and also listens to changes to expanded states in the layer tree.

The view keeps track of the current layer and emits a signal when the current layer has changed.

Allows the client to specify a context menu provider with custom actions. Also it comes with a set of default actions that can be used when building context menu.

See also

QgsLayerTreeModel

QgsLayerTreeView

Class Hierarchy

Base classes

QTreeView
QAbstractItemView
QAbstractScrollArea
QFrame
QWidget
QObject
QPaintDevice

Methods

addIndicator	Adds an indicator to the given layer tree node.
collapseAllNodes	Enhancement of QTreeView.collapseAll() that also records expanded state in layer tree nodes
currentGroupNode	Gets current group node.
currentLayer	Returns the currently selected layer, or None if no layers is selected.
currentLegendNode	Gets current legend node.
currentNode	Gets current node.
defaultActions	Gets access to the default actions that may be used with the tree view
expandAllNodes	Enhancement of QTreeView.expandAll() that also records expanded state in layer tree nodes
hideValidLayers	Returns if valid layers should be hidden (i.e. only invalid layers are shown).
index2legendNode	Returns legend node for given proxy model tree index.
index2node	Returns layer tree node for given proxy model tree index.
indicators	Returns list of indicators associated with a particular layer tree node.
layerForIndex
layerMarkWidth	Returns width of contextual menu mark, at right of layer node items.
layerTreeModel	Gets access to the model casted to QgsLayerTreeModel
legendNode2index	Returns proxy model index for a given legend node.
legendNode2sourceIndex	Returns index for a given legend node.
menuProvider	Returns pointer to the context menu provider.
modelRowsInserted
modelRowsRemoved
node2index	Returns proxy model index for a given node.
node2sourceIndex	Returns source model index for a given node.
onCurrentChanged
onExpandedChanged
onModelReset
proxyModel	Returns the proxy model used by the view.
refreshLayerSymbology	Force refresh of layer symbology.
removeIndicator	Removes a previously added indicator to a layer tree node.
selectedLayerNodes	Returns the list of selected nodes filtered to just layer nodes (QgsLayerTreeLayer).
selectedLayers	Returns the list of selected layers.
selectedLayersRecursive	Gets list of selected layers, including those that are not directly selected, but their ancestor groups is selected.
selectedLegendNodes	Returns the list of selected legend nodes.
selectedNodes	Returns the list of selected layer tree nodes.
setCurrentLayer	Sets the currently selected layer.
setCurrentNode	Sets the currently selected node.
setHideValidLayers	Sets whether valid layers should be hidden (i.e. only invalid layers are shown).
setLayerMarkWidth	Set width of contextual menu mark, at right of layer node items.
setLayerVisible	Convenience methods which sets the visible state of the specified map layer.
setMenuProvider	Sets provider for context menu.
setMessageBar	Set the message bar to display messages from the layer tree
setShowPrivateLayers	Set the show private layers to showPrivate
showPrivateLayers	Returns the show private layers status
updateExpandedStateFromNode
updateExpandedStateToNode

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsLayerTreeView. See the FAQ for more details.

setModel

Overridden setModel() from base class.

Signals

contextMenuAboutToShow	Emitted when the context menu is about to show.
currentLayerChanged	Emitted when a current layer is changed
datasetsDropped	Emitted when datasets are dropped onto the layer tree view

class qgis.gui.QgsLayerTreeView

Bases: QTreeView

__init__(parent: QWidget | None = None)

Constructor for QgsLayerTreeView

Parameters:

parent (Optional[QWidget] = None)

addIndicator(self, node: QgsLayerTreeNode | None, indicator: QgsLayerTreeViewIndicator | None)

Adds an indicator to the given layer tree node. Indicators are icons shown next to layer/group names in the layer tree view. They can be used to show extra information with tree nodes and they allow user interaction.

Does not take ownership of the indicator. One indicator object may be used for multiple layer tree nodes.

See also

removeIndicator()

See also

indicators()

Added in version 3.2.

Parameters:

• node (Optional[QgsLayerTreeNode])

• indicator (Optional[QgsLayerTreeViewIndicator])

collapseAllNodes(self)

Enhancement of QTreeView.collapseAll() that also records expanded state in layer tree nodes

signal contextMenuAboutToShow(menu: QMenu)

Emitted when the context menu is about to show.

Allows customization of the menu.

Added in version 3.32.

Parameters:

menu (QMenu)

currentGroupNode(self) → QgsLayerTreeGroup | None

Gets current group node. If a layer is current node, the function will return parent group. May be None.

Return type:

Optional[QgsLayerTreeGroup]

currentLayer(self) → QgsMapLayer | None

Returns the currently selected layer, or None if no layers is selected.

See also

setCurrentLayer()

Return type:

Optional[QgsMapLayer]

signal currentLayerChanged(layer: QgsMapLayer)

Emitted when a current layer is changed

Parameters:

layer (QgsMapLayer)

currentLegendNode(self) → QgsLayerTreeModelLegendNode | None

Gets current legend node. May be None if current node is not a legend node.

Return type:

Optional[QgsLayerTreeModelLegendNode]

currentNode(self) → QgsLayerTreeNode | None

Gets current node. May be None

Return type:

Optional[QgsLayerTreeNode]

signal datasetsDropped(event: QDropEvent)

Emitted when datasets are dropped onto the layer tree view

Parameters:

event (QDropEvent)

defaultActions(self) → QgsLayerTreeViewDefaultActions | None

Gets access to the default actions that may be used with the tree view

Return type:

Optional[QgsLayerTreeViewDefaultActions]

expandAllNodes(self)

Enhancement of QTreeView.expandAll() that also records expanded state in layer tree nodes

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

index2legendNode(self, index: QModelIndex) → QgsLayerTreeModelLegendNode | None

Returns legend node for given proxy model tree index. Returns None for invalid index

Unlike QgsLayerTreeModel.index2legendNode(), calling this method correctly accounts for mapping the view indexes through the view’s proxy model to the source model.

Added in version 3.18.

Parameters:

index (QModelIndex)

Return type:

Optional[QgsLayerTreeModelLegendNode]

index2node(self, index: QModelIndex) → QgsLayerTreeNode | None

Returns layer tree node for given proxy model tree index. Returns root node for invalid index. Returns None if index does not refer to a layer tree node (e.g. it is a legend node)

Unlike QgsLayerTreeModel.index2Node(), calling this method correctly accounts for mapping the view indexes through the view’s proxy model to the source model.

Added in version 3.18.

Parameters:

index (QModelIndex)

Return type:

Optional[QgsLayerTreeNode]

indicators(self, node: QgsLayerTreeNode | None) → List[QgsLayerTreeViewIndicator]

Returns list of indicators associated with a particular layer tree node.

See also

addIndicator()

See also

removeIndicator()

Added in version 3.2.

Parameters:

node (Optional[QgsLayerTreeNode])

Return type:

List[QgsLayerTreeViewIndicator]

layerForIndex(self, index: QModelIndex) → QgsMapLayer | None

Parameters:

index (QModelIndex)

Return type:

Optional[QgsMapLayer]

layerMarkWidth(self) → int

Returns width of contextual menu mark, at right of layer node items.

See also

setLayerMarkWidth()

Added in version 3.8.

Return type:

int

layerTreeModel(self) → QgsLayerTreeModel | None

Gets access to the model casted to QgsLayerTreeModel

Return type:

Optional[QgsLayerTreeModel]

legendNode2index(self, legendNode: QgsLayerTreeModelLegendNode | None) → QModelIndex

Returns proxy model index for a given legend node. If the legend node does not belong to the layer tree, the result is undefined. If the legend node is belongs to the tree but it is filtered out, invalid model index is returned.

Unlike QgsLayerTreeModel.legendNode2index(), calling this method correctly accounts for mapping the view indexes through the view’s proxy model to the source model.

Added in version 3.18.

Parameters:

legendNode (Optional[QgsLayerTreeModelLegendNode])

Return type:

QModelIndex

legendNode2sourceIndex(self, legendNode: QgsLayerTreeModelLegendNode | None) → QModelIndex

Returns index for a given legend node. If the legend node does not belong to the layer tree, the result is undefined. If the legend node is belongs to the tree but it is filtered out, invalid model index is returned.

Added in version 3.18.

Parameters:

legendNode (Optional[QgsLayerTreeModelLegendNode])

Return type:

QModelIndex

menuProvider(self) → QgsLayerTreeViewMenuProvider | None

Returns pointer to the context menu provider. May be None

Return type:

Optional[QgsLayerTreeViewMenuProvider]

modelRowsInserted(self, index: QModelIndex, start: int, end: int)

Parameters:

• index (QModelIndex)

• start (int)

• end (int)

modelRowsRemoved(self)

node2index(self, node: QgsLayerTreeNode | None) → QModelIndex

Returns proxy model index for a given node. If the node does not belong to the layer tree, the result is undefined

Unlike QgsLayerTreeModel.node2index(), calling this method correctly accounts for mapping the view indexes through the view’s proxy model to the source model.

Added in version 3.18.

Parameters:

node (Optional[QgsLayerTreeNode])

Return type:

QModelIndex

node2sourceIndex(self, node: QgsLayerTreeNode | None) → QModelIndex

Returns source model index for a given node. If the node does not belong to the layer tree, the result is undefined

Added in version 3.18.

Parameters:

node (Optional[QgsLayerTreeNode])

Return type:

QModelIndex

onCurrentChanged(self)

onExpandedChanged(self, node: QgsLayerTreeNode | None, expanded: bool)

Parameters:

• node (Optional[QgsLayerTreeNode])

• expanded (bool)

onModelReset(self)

proxyModel(self) → QgsLayerTreeProxyModel | None

Returns the proxy model used by the view.

This can be used to set filters controlling which layers are shown in the view.

Added in version 3.18.

Return type:

Optional[QgsLayerTreeProxyModel]

refreshLayerSymbology(self, layerId: str | None)

Force refresh of layer symbology. Normally not needed as the changes of layer’s renderer are monitored by the model

Parameters:

layerId (Optional[str])

removeIndicator(self, node: QgsLayerTreeNode | None, indicator: QgsLayerTreeViewIndicator | None)

Removes a previously added indicator to a layer tree node. Does not delete the indicator.

See also

addIndicator()

See also

indicators()

Added in version 3.2.

Parameters:

• node (Optional[QgsLayerTreeNode])

• indicator (Optional[QgsLayerTreeViewIndicator])

selectedLayerNodes(self) → List[QgsLayerTreeLayer]

Returns the list of selected nodes filtered to just layer nodes (QgsLayerTreeLayer).

See also

selectedNodes()

See also

selectedLayers()

See also

selectedLegendNodes()

Return type:

List[QgsLayerTreeLayer]

selectedLayers(self) → List[QgsMapLayer]

Returns the list of selected layers.

See also

selectedNodes()

See also

selectedLayerNodes()

See also

selectedLegendNodes()

Return type:

List[QgsMapLayer]

selectedLayersRecursive(self) → List[QgsMapLayer]

Gets list of selected layers, including those that are not directly selected, but their ancestor groups is selected. If we have a group with two layers L1, L2 and just the group node is selected, this method returns L1 and L2, while selectedLayers() returns an empty list.

Added in version 3.4.

Return type:

List[QgsMapLayer]

selectedLegendNodes(self) → List[QgsLayerTreeModelLegendNode]

Returns the list of selected legend nodes.

See also

selectedNodes()

See also

selectedLayerNodes()

Added in version 3.32.

Return type:

List[QgsLayerTreeModelLegendNode]

selectedNodes(self, skipInternal: bool = False) → List[QgsLayerTreeNode]

Returns the list of selected layer tree nodes.

Parameters:

skipInternal (bool = False) – If True, will ignore nodes which have an ancestor in the selection

See also

selectedLayerNodes()

See also

selectedLegendNodes()

See also

selectedLayers()

Return type:

List[QgsLayerTreeNode]

setCurrentLayer(self, layer: QgsMapLayer | None)

Sets the currently selected layer.

If layer is None then all layers will be deselected.

See also

currentLayer()

Parameters:

layer (Optional[QgsMapLayer])

setCurrentNode(self, node: QgsLayerTreeNode | None)

Sets the currently selected node.

If node is None then all nodes will be deselected.

See also

currentNode()

Added in version 3.40.

Parameters:

node (Optional[QgsLayerTreeNode])

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)

setLayerMarkWidth(self, width: int)

Set width of contextual menu mark, at right of layer node items.

See also

layerMarkWidth()

Added in version 3.8.

Parameters:

width (int)

setLayerVisible(self, layer: QgsMapLayer | None, visible: bool)

Convenience methods which sets the visible state of the specified map layer.

See also

QgsLayerTreeNode.setItemVisibilityChecked()

Added in version 3.10.

Parameters:

• layer (Optional[QgsMapLayer])

• visible (bool)

setMenuProvider(self, menuProvider: QgsLayerTreeViewMenuProvider | None)

Sets provider for context menu. Takes ownership of the instance

Parameters:

menuProvider (Optional[QgsLayerTreeViewMenuProvider])

setMessageBar(self, messageBar: QgsMessageBar | None)

Set the message bar to display messages from the layer tree

Added in version 3.14.

Parameters:

messageBar (Optional[QgsMessageBar])

virtual setModel(self, model: QAbstractItemModel | None)

Overridden setModel() from base class. Only QgsLayerTreeModel is an acceptable model.

Note

This method automatically creates a QgsLayerTreeProxyModel to use as a proxy.

Parameters:

model (Optional[QAbstractItemModel])

virtual setModel(self, model: QgsLayerTreeModel | None, proxyModel: QgsLayerTreeProxyModel | None)

Sets the model and proxyModel for the view.

Use this method when a custom proxy model is required.

Added in version 4.0.

Parameters:

• model (Optional[QgsLayerTreeModel])

• proxyModel (Optional[QgsLayerTreeProxyModel])

setShowPrivateLayers(self, showPrivate: bool)

Set the show private layers to showPrivate

Added in version 3.18.

Parameters:

showPrivate (bool)

showPrivateLayers(self) → bool

Returns the show private layers status

Added in version 3.18.

Return type:

bool

updateExpandedStateFromNode(self, node: QgsLayerTreeNode | None)

Parameters:

node (Optional[QgsLayerTreeNode])

updateExpandedStateToNode(self, index: QModelIndex)

Parameters:

index (QModelIndex)