Class: QgsAbstractLayoutIterator¶
-
class
qgis.core.
QgsAbstractLayoutIterator
¶ Bases:
sip.wrapper
An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter.
New in version 3.0: Enums
Methods
Called when rendering begins, before iteration commences.
Returns the number of features to iterate over.
Ends the render, performing any required cleanup tasks.
Returns the file path for the current feature, based on a specified base file path and extension.
Returns the layout associated with the iterator.
Iterates to next feature, returning
False
if no more features exist to iterate over.Signals
Attributes
-
beginRender
(self) → bool¶ Called when rendering begins, before iteration commences. Returns
True
if successful,False
if no iteration is available or required.See also
-
count
(self) → int¶ Returns the number of features to iterate over.
-
endRender
(self) → bool¶ Ends the render, performing any required cleanup tasks.
-
filePath
(self, baseFilePath: str, extension: str) → str¶ Returns the file path for the current feature, based on a specified base file path and extension.
-
layout
(self) → QgsLayout¶ Returns the layout associated with the iterator.
-
next
(self) → bool¶ Iterates to next feature, returning
False
if no more features exist to iterate over.
-