4. الوصول إلى جدول المحتويات (TOC)

تلميح

تحتاج مقتطفات الشيفرة في هذه الصفحة إلى عمليات الاستيراد التالية إذا كنت خارج وحدة تحكم pyqgis:

from qgis.core import (
    QgsProject,
    QgsVectorLayer,
)

يمكنك استخدام أصناف مختلفة للوصول إلى جميع الطبقات المحمّلة في جدول المحتويات واستخدامها لاسترجاع المعلومات:

• QgsProject

• QgsLayerTreeGroup

4.1. الصنف QgsProject

يمكنك استخدام QgsProject لاسترجاع معلومات عن جدول المحتويات وجميع الطبقات المحمّلة.

عليك إنشاء instance من QgsProject واستخدام دوالها للحصول على الطبقات المحمّلة.

الدالة الرئيسية هي mapLayers()، وهي تُرجع قاموسًا بالطبقات المحمّلة:

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

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

مفاتيح القاموس keys هي معرّفات الطبقات الفريدة، بينما القيم values هي الكائنات المرتبطة بها.

أصبح من السهل الآن الحصول على أي معلومات أخرى عن الطبقات:

# 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)>}

يمكنك أيضًا الاستعلام في جدول المحتويات باستخدام اسم الطبقة:

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

ملاحظة

تُرجَع قائمة بجميع الطبقات المطابقة، لذا نستخدم الفهرس [0] للحصول على أول طبقة تحمل هذا الاسم.

4.2. QgsLayerTreeGroup class

شجرة الطبقات بنية شجرية تقليدية مكوّنة من عُقد. يوجد حاليًا نوعان من العُقد: عُقد المجموعات (QgsLayerTreeGroup) وعُقد الطبقات (QgsLayerTreeLayer).

ملاحظة

لمزيد من المعلومات يمكنك قراءة تدوينات Martin Dobias التالية: الجزء 1 الجزء 2 الجزء 3

يمكن الوصول إلى شجرة طبقات المشروع بسهولة باستخدام الدالة layerTreeRoot() من الصنف QgsProject:

root = QgsProject.instance().layerTreeRoot()

العقدة root عقدة مجموعة ولها أبناء:

root.children()

تُرجَع قائمة بالأبناء المباشرين. ويجب الوصول إلى أبناء المجموعات الفرعية من خلال الأب المباشر لكل منها.

يمكننا استرجاع أحد الأبناء:

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

<QgsLayerTreeLayer: countries>

يمكن أيضًا استرجاع الطبقات باستخدام معرّفها الفريد id:

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

ويمكن كذلك البحث عن المجموعات باستخدام أسمائها:

root.findGroup('Group Name')

يحتوي الصنف QgsLayerTreeGroup على دوال مفيدة أخرى كثيرة يمكن استخدامها للحصول على مزيد من المعلومات عن جدول المحتويات:

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

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

لنُضف الآن بعض الطبقات إلى شجرة طبقات المشروع. هناك طريقتان للقيام بذلك:

1. الإضافة الصريحة باستخدام الدالتين addLayer() أو insertLayer():

   # 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. الإضافة الضمنية: بما أن شجرة طبقات المشروع متصلة بسجل الطبقات، يكفي إضافة الطبقة إلى سجل طبقات الخريطة:

   QgsProject.instance().addMapLayer(layer1)
   

يمكنك التبديل بسهولة بين QgsVectorLayer و 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)>

يمكن إضافة المجموعات باستخدام الدالة addGroup(). في المثال أدناه، يضيف الأول مجموعة إلى نهاية جدول المحتويات، بينما يتيح لك الثاني إضافة مجموعة أخرى داخل مجموعة موجودة:

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

توجد دوال مفيدة كثيرة لنقل العُقد والمجموعات.

يتم نقل عقدة موجودة في ثلاث خطوات:

1. استنساخ العقدة الموجودة

2. نقل العقدة المستنسخة إلى الموضع المطلوب

3. حذف العقدة الأصلية

# 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)

نقل طبقة داخل مفتاح الخريطة أعقد قليلًا:

# 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)

أو نقلها إلى مجموعة موجودة:

# 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)

بعض الدوال الأخرى التي يمكن استخدامها لتعديل المجموعات والطبقات:

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)