Class: QgsAbstractLayoutIterator¶
- class qgis.core.QgsAbstractLayoutIterator¶
Bases:
sip.wrapper
An abstract base class for
QgsLayout
based classes which can be exported byQgsLayoutExporter
.New in version 3.0:
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.- beginRender(self) bool ¶
Called when rendering begins, before iteration commences. Returns
True
if successful,False
if no iteration is available or required.See also
- Return type
bool
- count(self) int ¶
Returns the number of features to iterate over.
- Return type
int
- endRender(self) bool ¶
Ends the render, performing any required cleanup tasks.
- Return type
bool
- filePath(self, baseFilePath: str, extension: str) str ¶
Returns the file path for the current feature, based on a specified base file path and extension.
- Parameters
baseFilePath (str) –
extension (str) –
- Return type
str
- next(self) bool ¶
Iterates to next feature, returning
False
if no more features exist to iterate over.- Return type
bool