PyQGIS – Creating and Manipulating HTML Frame in QGIS 3.2.0 Print Composer

print-composerpyqgispyqgis-3qgis-3

I'm trying to create, reposition and resize an HTML frame in a QGIS 3.2.0 Print Composer layout using PyQGIS:

proj = QgsProject.instance()
comp = QgsPrintLayout(proj)
blockStats = QgsLayoutItemHtml.create(comp)
blockStats.setFixedSize(QgsLayoutSize(34.3,25, QgsUnitTypes.LayoutMillimeters))
blockStats.attemptMove(QgsLayoutPoint(200,89, QgsUnitTypes.LayoutMillimeters))
blockStats.setFrameEnabled(True)
blockStats.setFrameStrokeWidth(QgsLayoutMeasurement(0.5,QgsUnitTypes.LayoutMillimeters))
comp.addLayoutItem(blockStats)

Lines 4 and 5 above give me "object has no attribute" errors for 'setFixedSize' and 'attemptMove' – how can I reposition and resize this object?

Using the answer by @ndawson I've revised my code as follows:

proj = QgsProject.instance()
comp = QgsPrintLayout(proj)
blockStatsHTML = QgsLayoutItemHtml.create(comp)
blockStatsHTML.setHtml("test<br><b>test</b>")
blockStatsHTML.loadHtml()
blockStatsFrame = QgsLayoutFrame(comp, blockStatsHTML)
blockStatsHTML.addFrame(blockStatsFrame)
blockStatsFrame.setFixedSize(QgsLayoutSize(34.3,25, QgsUnitTypes.LayoutMillimeters))
blockStatsFrame.attemptMove(QgsLayoutPoint(100,100, QgsUnitTypes.LayoutMillimeters))
blockStatsFrame.setFrameEnabled(True)
blockStatsFrame.setFrameStrokeWidth(QgsLayoutMeasurement(0.5, QgsUnitTypes.LayoutMillimeters))
comp.addLayoutItem(blockStatsFrame)
comp.moveItemToTop(blockStatsFrame)

I'm no longer getting Python errors, however the frame still isn't appearing in the print layout. I've tried changing the position, using positive and negative coordinates, but I can't make it show up.

Is there another step required to make it visible?

Just an update and clarification – I've added the following line at the end of the code:

lmgr.addLayout(comp)

When I open the layout in the print composer, the Items Panel contains only "Map 1" – there is no listing for the blockStatsFrame or blockStatsHTML item. So this tells me any other attempts at removing or resizing the item would be futile, since it doesn't exist in the layout as far as the print composer is concerned.

Apart from comp.addLayoutItem(blockStatsFrame), should anything else be necessary in order to add the item to the layout?

In case anyone is facing the same issue, the solution for me was in using attemptSetSceneRect to set the dimensions of the frame. Without this, the frame didn't appear in the layout at all. Note however that after using this method, setFixedSize doesn't appear to work. Relevant parts of my working code are below:

proj = QgsProject.instance()
lmgr = proj.layoutManager()
comp = QgsPrintLayout(proj)

# create block stats HTML multiframe
blockStatsHTML = QgsLayoutItemHtml.create(comp)

# create frame to show content from blockStatsHTML
blockStatsFrame = QgsLayoutFrame(comp, blockStatsHTML)
blockStatsFrame.attemptSetSceneRect(QRectF(10, 10, 30, 20))
blockStatsFrame.setFrameEnabled(True)
blockStatsHTML.addFrame(blockStatsFrame)

# set HTML contents
blockStatsHTML.setContentMode(QgsLayoutItemHtml.ManualHtml)
blockStatsHTML.setHtml("test<br><b>test</b>")
blockStatsHTML.loadHtml()

# reposition blockStatsFrame
blockStatsFrame.attemptMove(QgsLayoutPoint(10,10, QgsUnitTypes.LayoutMillimeters))

# set frame outline
blockStatsFrame.setFrameStrokeColor(QColor(255, 0, 255))
blockStatsFrame.setFrameStrokeWidth(QgsLayoutMeasurement(1, QgsUnitTypes.LayoutMillimeters))

# set frame background                        
blockStatsFrame.setBackgroundEnabled(True)
blockStatsFrame.setBackgroundColor(QColor(255, 255, 255))

# add frame to layout
comp.addLayoutItem(blockStatsFrame)

# add layout to layout manager
lmgr.addLayout(comp)

Best Answer

HTML layout items are "multi frame" items, which means that their content is split over multiple QgsLayoutFrame items.

After creating your QgsLayoutItemHtml, you need to then create frames to display the content. E.g.:

blockStats = QgsLayoutItemHtml.create(comp)

# create a frame for showing content from blockStats
frame1 = QgsLayoutFrame(comp, blockStats)
blockStats.addFrame(frame1)

# and resize/move the frame
frame1.setFixedSize(QgsLayoutSize(34.3,25, QgsUnitTypes.LayoutMillimeters))
frame1.attemptMove(QgsLayoutPoint(200,89, QgsUnitTypes.LayoutMillimeters))

Related Solutions

[GIS] Print Composer Map with Table using PyQGIS

Which version of QGIS are you using? If it's 2.4, you can set the columns shown in a QgsComposerAttributeTable by using the setColumns method. This method takes a list of QgsComposerTableColumn. Here's an example

#create a composition and composer attribute table
composition = QgsComposition(iface.mapCanvas().mapSettings())
table = QgsComposerAttributeTable(composition)

#create columns for the table
col1 = QgsComposerTableColumn()
col1.setAttribute('feature_id')
col2 = QgsComposerTableColumn()
col2.setAttribute('feature_name')

#set table columns
table.setColumns([col1, col2])

There's a bunch of other things you can set for columns, such as the heading, alignment and sort order (see api docs here). You can even set an expression for a column in place of the attribute for added flexibility.

edit: To show only certain features you can set a filter on the table:

table.setFeatureFilter("id in (1,2,3)")
table.setFilterFeatures( True )

So, to filter a table to only selected features:

#get current layer
current_layer = qgis.utils.iface.mapCanvas().currentLayer()
#get list of selected feature ids
selected_ids = [f.id() for f in current_layer.selectedFeatures()]
#convert list to string
filter_id_string = ','.join([str(id) for id in selected_ids])
#filter table
table.setFeatureFilter("$id in (" + filter_id_string + ")")
table.setFilterFeatures( True )

update: I missed a character in the filter expression. It should have been "$id in (...". Here's a complete, working version of the code you posted. There was a few simple mistakes (the constructor for QgsLegendModel takes no arguments, there's no applyDefaultSize method for attribute tables, and I've also moved the attribute table setItemPosition line):

from PyQt4.QtCore import *
from PyQt4.QtGui import *

layer = qgis.utils.iface.activeLayer()

qgis.utils.iface.actionZoomToSelected().trigger()
qgis.utils.iface.mapCanvas().zoomScale(1000)

mapRenderer = iface.mapCanvas().mapRenderer()
c = QgsComposition(mapRenderer)
c.setPlotStyle(QgsComposition.Print)
x, y = 0, 0
w, h = c.paperWidth(), c.paperHeight()
composerMap = QgsComposerMap(c, x,y,w*.75,h)
c.addItem(composerMap)

legend = QgsComposerLegend(c)
c.addComposerLegend(legend)
legend.model().setLayerSet(mapRenderer.layerSet())
legend.setTitle('')

legendModel = QgsLegendModel()
legendModel.setLayerSet([layer.id()])

legend.updateLegend()

selected_ids = [f.id() for f in layer.selectedFeatures()]
filter_id_string = ','.join([str(id) for id in selected_ids])

table = QgsComposerAttributeTable(c)
table.setItemPosition(x+50, y+50)
table.setVectorLayer(layer)
table.setMaximumNumberOfFeatures(20)
table.setFeatureFilter("$id in (" + filter_id_string + ")")
table.setFilterFeatures(True)
col1 = QgsComposerTableColumn()
col1.setAttribute('Diametre')
col1.setHeading("Diametre")
col2 = QgsComposerTableColumn()
col2.setAttribute('Nature')
col2.setHeading("Nature")
table.setColumns([col1, col2])
c.addItem(table)

printer = QPrinter()
printer.setOutputFormat(QPrinter.PdfFormat)
printer.setOutputFileName('out.pdf')
printer.setPaperSize(QSizeF(c.paperWidth(), c.paperHeight()), QPrinter.Millimeter)
printer.setFullPage(True)
printer.setColorMode(QPrinter.Color)
printer.setResolution(c.printResolution())
pdfPainter = QPainter(printer)
paperRectMM = printer.pageRect(QPrinter.Millimeter)
paperRectPixel = printer.pageRect(QPrinter.DevicePixel)
c.render(pdfPainter, paperRectPixel, paperRectMM)
pdfPainter.end()

QGIS Print Composer – Changing Frame in QGIS Print Composer

There is Resize page to content option in Composition tab (QGIS 2.18). You can set the margins and click on the Resize page button.

Best Answer

Related Solutions

[GIS] Print Composer Map with Table using PyQGIS

QGIS Print Composer – Changing Frame in QGIS Print Composer

Related Question