[GIS] Loading print layout using an existing template (.qpt) with PyQgis3

pyqgis-3qgis-print-layouts

I'm trying to load a print layout (.qpt) which I saved earlier via PyQgis.

I found this earlier entry, but it's for QGIS 2.x and thus doesn't work for QGIS3:
Programmatically load composer from template and generate atlas using pyQgis

Does anyone know how to do this in QGIS3?

Best Answer

For load qpt in QGIS 3 you need something like this:

# Load template from file
p = QgsProject()
l = QgsLayout(p)
tmpfile = 'D://temp//test.qpt'
with open(tmpfile) as f:
    template_content = f.read()
doc = QDomDocument()
doc.setContent(template_content)

# adding to existing items
items, ok = l.loadFromTemplate(doc, QgsReadWriteContext(), False)

look at the API loadFromTemplate()

Related Solutions

[GIS] Editing Layout-Items after loading a QPT-Template in QGIS 3 with Python

First you need to get the layout as it has been added.

layout = QgsProject.instance().layoutManager().layoutByName("My comp name")

Then with this class can access to your table item by requesting its id if you had set one.

my_table = layout.itemById()

Then working on this particular item like check data or add data. I did'nt use it.

my_table.data(0)
my_table.data(0, "some data")

Hope It gave you some hint to start working.

[GIS] Using Python to set text for a label in a QGIS3 print layout label

Try something like this. Keep in mind, you already need to have created a print layout

#create a layout item (a label in this case)
map_label = QgsLayoutItemLabel(layout)    

#set what the text will be
map_label.setText("This is a map label")

#change font style and size (optional)
map_label.setFont(QFont("Arial", 12))

#set size of label item. this step seems a little pointless to me but it doesn't work without it
label.adjustSizeToText() 

#add map_label to your layout
layout.addLayoutItem(map_label)

#another thing you probably want to do is specify where your label is on the print layout
map_label.attemptMove(QgsLayoutPoint(0.25, 0.25, QgsUnitTypes.LayoutInches))

Here is the documentation page for class QgsLayoutItemLabel() where you can see all the class methods such as setFont(), setFontColor(). In this example I used one, setText().

Best Answer

Related Solutions

[GIS] Editing Layout-Items after loading a QPT-Template in QGIS 3 with Python

[GIS] Using Python to set text for a label in a QGIS3 print layout label

Related Question