Adding layer group using PyQGIS?

Question

How can I create a new group in the layer manager using python code?

Germán Carrillo · Answer 1 · 2019-10-28T14:47:47.477

34

Adding groups to the Layers Panel

Using the new Layer tree (introduced since QGIS v.2.4 and available for QGIS v3.x) you can add a group to the QGIS ToC this way:

root = QgsProject.instance().layerTreeRoot()
myGroup1 = root.addGroup("My Group 1")

If you want to add it to a particular position in the ToC, use:

myGroup1 = root.insertGroup(2, "My Group 1")

You can even create nested groups (a group into a group):

myGroupA = myGroup1.addGroup("My Group A")

If you need to first find an existing group where to put your new group, use this:

myOriginalGroup = root.findGroup("My existing group") # We assume the group exists
myNewGroup = myOriginalGroup.addGroup("My New Group")

You can learn more on Layer tree handling here and here.

edited Oct 28 '19 at 14:47

answered Feb 13 '15 at 20:50

Germán Carrillo

I cannot find explanation to what ToC means? – J.A.Cado Dec 07 '17 at 08:42
1

Layer tree, legend, ToC, they are names normally used in GIS when refering to the list of layers and groups in a software. – Germán Carrillo Dec 07 '17 at 13:51

Matthias Kuhn · Answer 2 · 2013-07-16T11:14:27.363

4

Example:

iface.legendInterface().addGroup( 'abc')

edited Jul 16 '13 at 11:14

answered Jul 16 '13 at 11:04

Matthias Kuhn

Thank you very much, the problem was that I did not refer to the interface and used directly QgsLegendInterface.addGroup – malagueff Jul 16 '13 at 11:54
Is there any way to control the position where you insert the menu? The menu is inserted under the shape you have selected. I need to put it above all layers. Thanks. – malagueff Jul 17 '13 at 05:35
@malagueff, Please edit your question per your comment. – artwork21 Apr 02 '14 at 14:36