4. Accedere alla Legenda (o Table Of Contents - TOC)

Suggerimento

I frammenti di codice di questa pagina necessitano delle seguenti importazioni se si è fuori dalla console pyqgis:

from qgis.core import (
    QgsProject,
    QgsVectorLayer,
)

Puoi usare diverse classi per accedere a tutti i layer caricati nella legenda e usarli per recuperare informazioni:

• QgsProject

• QgsLayerTreeGroup

4.1. La classe QgsProject

Puoi usare QgsProject per recuperare informazioni sulla legenda e su tutti i layer caricati.

Devi creare un”instanza di QgsProject e utilizzare i suoi metodi per ottenere i layer caricati.

Il metodo principale è mapLayers(). Restituisce un dizionario dei layer caricati:

layers = QgsProject.instance().mapLayers()
print(layers)

{'countries_89ae1b0f_f41b_4f42_bca4_caf55ddbe4b6': <QgsVectorLayer: 'countries' (ogr)>}

Le ``chiavi”” del dizionario sono gli id univoci dei layer, mentre i ``valori”” sono gli oggetti correlati.

A questo punto è facile ottenere qualsiasi altra informazione sui layer:

# list of layer names using list comprehension
l = [layer.name() for layer in QgsProject.instance().mapLayers().values()]
# dictionary with key = layer name and value = layer object
layers_list = {}
for l in QgsProject.instance().mapLayers().values():
  layers_list[l.name()] = l

print(layers_list)

{'countries': <QgsVectorLayer: 'countries' (ogr)>}

Puoi anche interrogare la legenda utilizzando il nome del layer:

country_layer = QgsProject.instance().mapLayersByName("countries")[0]

Nota

Viene restituito un elenco con tutti i layer corrispondenti, quindi si indicizza con [0] per ottenere il primo layer con questo nome.

4.2. Classe QgsLayerTreeGroup

L’albero dei layer è una classica struttura ad albero composta da nodi. Attualmente esistono due tipi di nodi: nodi di gruppo (QgsLayerTreeGroup) e nodi di layer (QgsLayerTreeLayer).

Nota

Per ulteriori informazioni puoi leggere questi post del blog di Martin Dobias: Part 1 Part 2 Part 3

L’albero dei layer del progetto è facilmente accessibile con il metodo layerTreeRoot() della classe QgsProject:

root = QgsProject.instance().layerTreeRoot()

root è un nodo di gruppo e ha children:

root.children()

Viene restituito un elenco di figli diretti. I figli del sottogruppo devono essere accessibili dal proprio genitore diretto.

Possiamo recuperare uno dei figli:

child0 = root.children()[0]
print(child0)

<QgsLayerTreeLayer: countries>

I layer possono anche essere recuperati usando il loro ``id”” (univoco):

ids = root.findLayerIds()
# access the first layer of the ids list
root.findLayer(ids[0])

E anche I gruppi possono essere cercati utilizzando i loro nomi:

root.findGroup('Group Name')

QgsLayerTreeGroup ha molti altri metodi utili che possono essere usati per ottenere ulteriori informazioni sulla TOC:

# list of all the checked layers in the TOC
checked_layers = root.checkedLayers()
print(checked_layers)

[<QgsVectorLayer: 'countries' (ogr)>]

Ora aggiungiamo alcuni layer all’albero dei layer del progetto. Ci sono due modi per farlo:

1. Explicit addition usando il addLayer() o insertLayer() functions:

   # create a temporary layer
   layer1 = QgsVectorLayer("path_to_layer", "Layer 1", "memory")
   # add the layer to the legend, last position
   root.addLayer(layer1)
   # add the layer at given position
   root.insertLayer(5, layer1)
   

2. Aggiunta implicita: poiché l’albero dei layer del progetto è collegato al registro dei layer, è sufficiente aggiungere un layer al registro dei layer della mappa:

   QgsProject.instance().addMapLayer(layer1)
   

Puoi passare facilmente da QgsVectorLayer a QgsLayerTreeLayer:

node_layer = root.findLayer(country_layer.id())
print("Layer node:", node_layer)
print("Map layer:", node_layer.layer())

Layer node: <QgsLayerTreeLayer: countries>
Map layer: <QgsVectorLayer: 'countries' (ogr)>

I gruppi possono essere aggiunti con il metodo addGroup(). Nell’esempio che segue, il primo aggiungerà un gruppo alla fine della legenda, mentre il secondo può aggiungere un altro gruppo all’interno di uno esistente:

node_group1 = root.addGroup('Simple Group')
# add a sub-group to Simple Group
node_subgroup1 = node_group1.addGroup("I'm a sub group")

Per spostare nodi e gruppi esistono molti metodi validi.

Lo spostamento di un nodo esistente avviene in tre passi:

1. clonazione del nodo esistente

2. spostamento del nodo clonato nella posizione desiderata

3. eliminazione del nodo originale

# clone the group
cloned_group1 = node_group1.clone()
# move the node (along with sub-groups and layers) to the top
root.insertChildNode(0, cloned_group1)
# remove the original node
root.removeChildNode(node_group1)

È un po” più complicato spostare un layer nella legenda:

# get a QgsVectorLayer
vl = QgsProject.instance().mapLayersByName("countries")[0]
# create a QgsLayerTreeLayer object from vl by its id
myvl = root.findLayer(vl.id())
# clone the myvl QgsLayerTreeLayer object
myvlclone = myvl.clone()
# get the parent. If None (layer is not in group) returns ''
parent = myvl.parent()
# move the cloned layer to the top (0)
parent.insertChildNode(0, myvlclone)
# remove the original myvl
root.removeChildNode(myvl)

o spostarlo in un gruppo esistente:

# get a QgsVectorLayer
vl = QgsProject.instance().mapLayersByName("countries")[0]
# create a QgsLayerTreeLayer object from vl by its id
myvl = root.findLayer(vl.id())
# clone the myvl QgsLayerTreeLayer object
myvlclone = myvl.clone()
# create a new group
group1 = root.addGroup("Group1")
# get the parent. If None (layer is not in group) returns ''
parent = myvl.parent()
# move the cloned layer to the top (0)
group1.insertChildNode(0, myvlclone)
# remove the QgsLayerTreeLayer from its parent
parent.removeChildNode(myvl)

Alcuni altri metodi che possono essere utilizzati per modificare gruppi e layer:

node_group1 = root.findGroup("Group1")
# change the name of the group
node_group1.setName("Group X")
node_layer2 = root.findLayer(country_layer.id())
# change the name of the layer
node_layer2.setName("Layer X")
# change the visibility of a layer
node_group1.setItemVisibilityChecked(True)
node_layer2.setItemVisibilityChecked(False)
# expand/collapse the group view
node_group1.setExpanded(True)
node_group1.setExpanded(False)