QGIS 3 Layers – How to Sort Layers in Table of Contents in QGIS 3

layerspyqgis-3qgis-3table of contents

When I load a bunch of layers into QGIS, they seem to load in reverse alphabetical order. I'd like to sort them alphabetically.

In this thread a solution is proposed, but that does not work in QGIS 2.18 or 3.4:

from PyQt4.QtCore import *
from PyQt4.QtGui import *
from qgis.utils import iface


mw = iface.mainWindow()
lgd = mw.findChild(QTreeWidget, "theMapLegend")  # get ref to object by type/objectName
lgd.sortItems(0, Qt.AscendingOrder)  # sort first column (Qt.DescendingOrder to reverse)

How can I do this in QGIS 3?
I tried:

from qgis.PyQt.QtCore import * 
from qgis.PyQt.QtGui import *
from qgis.utils import iface

mw = iface.mainWindow()
lgd = mw.findChild(QTreeView, 'theLayerTreeView')
lgd.sortItems(0, Qt.AscendingOrder)

It "works" until the last line, then I get the error:

Traceback (most recent call last):
File "C:\PROGRA~1\QGIS3~1.4\apps\Python37\lib\code.py", line 90, in runcode
exec(code, self.locals)
File "", line 1, in
AttributeError: 'QgsLayerTreeView' object has no attribute 'sortItems'

I don't know where to search for a method that will sort the layers as in the first code example.

Best Answer

You could use the following to sort all loaded layers alphabetically:

from collections import OrderedDict
root = QgsProject.instance().layerTreeRoot()
LayerNamesEnumDict=lambda listCh:{listCh[q[0]].name()+str(q[0]):q[1]
                                   for q in enumerate(listCh)}

mLNED = LayerNamesEnumDict(root.children())
mLNEDkeys = OrderedDict(sorted(LayerNamesEnumDict(root.children()).items())).keys()

mLNEDsorted = [mLNED[k].clone() for k in mLNEDkeys]
root.insertChildNodes(0,mLNEDsorted)
for n in mLNED.values():
    root.removeChildNode(n)

Credit to @MikhailMinin with his Sort Layers plugin in which the above code is based.

Related Solutions

QGIS – How to Sort Layers in QGIS Table of Contents

When I load a bunch of layers into QGIS from PostGIS, they seem to load in reverse alphabetical order.

This appears to be a bug (even in master branch) when using the add layer action Add PostGIS Layers... and should be reported on the QGIS bug tracker. However, if you use the new browser to load PostGIS layers, they will not be reversed. The new DB Manager does not allow multiple selections of tables, so no issue there (other than the lack of multiple selection).

Is there any tools or plugins that allow you to quickly sort the QGIS TOC in a different order? For example I can think of a couple of options one might want:

2) Sort Layers by name (alphabetical, reverse alphabetical).

This can currently be done by using the native column or item sorting of the base class of the QgsLegend (QTreeWidget). This will sort ALL ITEMS, both layers and groups together, not groups grouped above or below top-level layers. It will also sort within groups. There is NO UNDO of sorting like this.

from PyQt4.QtCore import *
from PyQt4.QtGui import *
from qgis.utils import iface

mw = iface.mainWindow()
lgd = mw.findChild(QTreeWidget, "theMapLegend")  # get ref to object by type/objectName
lgd.sortItems(0, Qt.AscendingOrder)  # sort first column (Qt.DescendingOrder to reverse)

Caveat: If the main legend also controls layer render order (default), this should work OK. If the Layer Order dock widget is used separately to control render order, then the sort order in the legend is not honored and the following sort operation may lead to undesired results (continuing from above):

lo = mw.findChild(QListWidget, "theMapLayerOrder")
lo.sortItems(Qt.AscendingOrder)

From this code you can see that the Layer Order listing is a QListWidget, not a QTreeWidget, which means sorting will NOT take into account any groupings. All layers are presented in a flat list, as if they were all top-level. So, any layers currently nested in groups may sort above below top-level layers, if you apply the above sorting code to the QListWidget.

1) Sort layers by geometry, where points are on top, then lines, polys, & rasters.

3) Sort first by geometry, then by name. This would be a combination of #1 & #2. Points layers are sorted to the top (same as #1), but then points layers are sorted alphabetically (point-a, point-b, point-c, etc).

Currently, using Python, there is limited functionality for manipulating the QgsLegend. There is the QgsLegendInterface but this does not have all the goodies that are present in the QgsLegend, QgsLegendLayer, the inherited QgsLegendItem, or any of the other classes associated with QgsLegend.

Although, if you are starting with a clean project, and don't mind using groups, the following is currently possible (continuing from initial code block):

li = iface.legendInterface()
li.addGroup('A_Points')
li.addGroup('B_Lines')
li.addGroup('C_Polygons')
li.addGroup('D_Rasters')

for l in li.layers():
  if l.type() == QgsMapLayer.VectorLayer:
    if l.geometryType() == QGis.Point:
      li.moveLayer(l, 0)
    elif l.geometryType() == QGis.Line:
      li.moveLayer(l, 1)
    elif l.geometryType() == QGis.Polygon:
      li.moveLayer(l, 2)
  elif l.type() == QgsMapLayer.RasterLayer:
    li.moveLayer(l, 3)

lgd.sortItems(0, Qt.AscendingOrder)

(Assumes no other groups exist.) This would be run from console ( or ScriptRunner script, or Plugin, or loaded into new console in master) after the layers were added. It will create groups with sortable names, add layers to correct groups, then sort the whole thing. Same caveat applies, as above.

More checks for correct group indices would be needed for a more robust solution when adding new layers to an existing project with already-loaded layers and groups.

[GIS] Moving layers in QGIS Table of Contents via PyQGIS

With the new (since QGIS v.2.4) Layer tree by Martin Dobias, you can do this:

alayer = QgsProject.instance().mapLayersByName("Layer2")[0]
blayer = QgsProject.instance().mapLayersByName("Layer1")[0]

root = QgsProject.instance().layerTreeRoot()

# Move alayer
myalayer = root.findLayer(alayer.id())
myClone = myalayer.clone()
parent = myalayer.parent()
parent.insertChildNode(0, myClone)
parent.removeChildNode(myalayer)

# Move blayer
myblayer = root.findLayer(blayer.id())
myClone = myblayer.clone()
parent = myblayer.parent()
parent.insertChildNode(1, myClone)
parent.removeChildNode(myblayer)

As you see, to move the layer alayer you first clone it, insert the clone at the desired position*, and remove the original.

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

Note that if your original layer is at the position 0 and you want to move it to 1, you would need to insert it at the position 2 (instead of 1), because when the clone is inserted, the original layer is still there, so its index must be taken into account.

Best Answer

Related Solutions

QGIS – How to Sort Layers in QGIS Table of Contents

[GIS] Moving layers in QGIS Table of Contents via PyQGIS

Related Question