QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
Handles rendering and exports of layouts to various formats. More...
#include <qgslayoutexporter.h>
Classes | |
struct | ImageExportSettings |
Contains settings relating to exporting layouts to raster images. More... | |
struct | PageExportDetails |
Contains details of a page being exported by the class. More... | |
struct | PdfExportSettings |
Contains settings relating to exporting layouts to PDF. More... | |
struct | PrintExportSettings |
Contains settings relating to printing layouts. More... | |
struct | SvgExportSettings |
Contains settings relating to exporting layouts to SVG. More... | |
Public Types | |
enum | ExportResult { Success , Canceled , MemoryError , FileError , PrintError , SvgLayerError , IteratorError } |
Result codes for exporting layouts. More... | |
Public Member Functions | |
QgsLayoutExporter (QgsLayout *layout) | |
Constructor for QgsLayoutExporter, for the specified layout. More... | |
virtual | ~QgsLayoutExporter () |
void | computeWorldFileParameters (const QRectF ®ion, double &a, double &b, double &c, double &d, double &e, double &f, double dpi=-1) const |
Computes the world file parameters for a specified region of the layout. More... | |
void | computeWorldFileParameters (double &a, double &b, double &c, double &d, double &e, double &f, double dpi=-1) const |
Compute world file parameters. More... | |
QString | errorFile () const |
Returns the file name corresponding to the last error encountered during an export. More... | |
ExportResult | exportToImage (const QString &filePath, const QgsLayoutExporter::ImageExportSettings &settings) |
Exports the layout to the filePath, using the specified export settings. More... | |
ExportResult | exportToPdf (const QString &filePath, const QgsLayoutExporter::PdfExportSettings &settings) |
Exports the layout as a PDF to the filePath, using the specified export settings. More... | |
ExportResult | exportToSvg (const QString &filePath, const QgsLayoutExporter::SvgExportSettings &settings) |
Exports the layout as an SVG to the filePath, using the specified export settings. More... | |
bool | georeferenceOutput (const QString &file, QgsLayoutItemMap *referenceMap=nullptr, const QRectF &exportRegion=QRectF(), double dpi=-1) const |
Georeferences a file (image of PDF) exported from the layout. More... | |
QMap< QString, QgsLabelingResults * > | labelingResults () |
Returns the labeling results for all map items included in the export. More... | |
QgsLayout * | layout () const |
Returns the layout linked to this exporter. More... | |
ExportResult | print (QPrinter &printer, const QgsLayoutExporter::PrintExportSettings &settings) |
Prints the layout to a printer, using the specified export settings. More... | |
void | renderPage (QPainter *painter, int page) const |
Renders a full page to a destination painter. More... | |
QImage | renderPageToImage (int page, QSize imageSize=QSize(), double dpi=-1) const |
Renders a full page to an image. More... | |
void | renderRegion (QPainter *painter, const QRectF ®ion) const |
Renders a region from the layout to a painter. More... | |
QImage | renderRegionToImage (const QRectF ®ion, QSize imageSize=QSize(), double dpi=-1) const |
Renders a region of the layout to an image. More... | |
QMap< QString, QgsLabelingResults * > | takeLabelingResults () |
Takes the labeling results for all map items included in the export. More... | |
Static Public Member Functions | |
static bool | containsAdvancedEffects (const QgsLayout *layout) |
Returns true if the specified layout contains visible items which have settings such as opacity which will prevent these individual items from being exported as vector artwork. More... | |
static ExportResult | exportToImage (QgsAbstractLayoutIterator *iterator, const QString &baseFilePath, const QString &extension, const QgsLayoutExporter::ImageExportSettings &settings, QString &error, QgsFeedback *feedback=nullptr) |
Exports a layout iterator to raster images, with the specified export settings. More... | |
static ExportResult | exportToPdf (QgsAbstractLayoutIterator *iterator, const QString &fileName, const QgsLayoutExporter::PdfExportSettings &settings, QString &error, QgsFeedback *feedback=nullptr) |
Exports a layout iterator to a single PDF file, with the specified export settings. More... | |
static ExportResult | exportToPdfs (QgsAbstractLayoutIterator *iterator, const QString &baseFilePath, const QgsLayoutExporter::PdfExportSettings &settings, QString &error, QgsFeedback *feedback=nullptr) |
Exports a layout iterator to multiple PDF files, with the specified export settings. More... | |
static ExportResult | exportToSvg (QgsAbstractLayoutIterator *iterator, const QString &baseFilePath, const QgsLayoutExporter::SvgExportSettings &settings, QString &error, QgsFeedback *feedback=nullptr) |
Exports a layout iterator to SVG files, with the specified export settings. More... | |
static ExportResult | print (QgsAbstractLayoutIterator *iterator, QPrinter &printer, const QgsLayoutExporter::PrintExportSettings &settings, QString &error, QgsFeedback *feedback=nullptr) |
Exports a layout iterator to a printer, with the specified export settings. More... | |
static bool | requiresRasterization (const QgsLayout *layout) |
Returns true if the specified layout contains visible items which have settings that require rasterization of the entire export layout in order to reproduce the desired appearance. More... | |
Protected Member Functions | |
virtual QString | generateFileName (const PageExportDetails &details) const |
Generates the file name for a page during export. More... | |
Friends | |
class | TestQgsLayout |
class | TestQgsLayoutExporter |
Handles rendering and exports of layouts to various formats.
Definition at line 46 of file qgslayoutexporter.h.
Result codes for exporting layouts.
Definition at line 138 of file qgslayoutexporter.h.
PRIVATE QgsLayoutExporter::QgsLayoutExporter | ( | QgsLayout * | layout | ) |
Constructor for QgsLayoutExporter, for the specified layout.
Definition at line 148 of file qgslayoutexporter.cpp.
|
virtual |
Definition at line 154 of file qgslayoutexporter.cpp.
void QgsLayoutExporter::computeWorldFileParameters | ( | const QRectF & | region, |
double & | a, | ||
double & | b, | ||
double & | c, | ||
double & | d, | ||
double & | e, | ||
double & | f, | ||
double | dpi = -1 |
||
) | const |
Computes the world file parameters for a specified region of the layout.
The dpi argument can be set to the actual DPI of exported file, or left as -1 to use the layout's default DPI.
Definition at line 1883 of file qgslayoutexporter.cpp.
void QgsLayoutExporter::computeWorldFileParameters | ( | double & | a, |
double & | b, | ||
double & | c, | ||
double & | d, | ||
double & | e, | ||
double & | f, | ||
double | dpi = -1 |
||
) | const |
Compute world file parameters.
Assumes the whole page containing the reference map item will be exported.
The dpi argument can be set to the actual DPI of exported file, or left as -1 to use the layout's default DPI.
Definition at line 1864 of file qgslayoutexporter.cpp.
|
static |
Returns true
if the specified layout contains visible items which have settings such as opacity which will prevent these individual items from being exported as vector artwork.
Definition at line 1975 of file qgslayoutexporter.cpp.
|
inline |
Returns the file name corresponding to the last error encountered during an export.
Definition at line 595 of file qgslayoutexporter.h.
PRIVATE QgsLayoutExporter::ExportResult QgsLayoutExporter::exportToImage | ( | const QString & | filePath, |
const QgsLayoutExporter::ImageExportSettings & | settings | ||
) |
Exports the layout to the filePath, using the specified export settings.
If the layout is a multi-page layout, then filenames for each page will automatically be generated by appending "_1", "_2", etc to the image file's base name.
Returns a result code indicating whether the export was successful or an error was encountered. If an error code is returned, errorFile() can be called to determine the filename for the export which encountered the error.
Definition at line 370 of file qgslayoutexporter.cpp.
|
static |
Exports a layout iterator to raster images, with the specified export settings.
The baseFilePath argument gives a base file path, which is modified by the iterator to obtain file paths for each iterator feature.
Returns a result code indicating whether the export was successful or an error was encountered. If an error was obtained then error will be set to the error description.
Definition at line 480 of file qgslayoutexporter.cpp.
QgsLayoutExporter::ExportResult QgsLayoutExporter::exportToPdf | ( | const QString & | filePath, |
const QgsLayoutExporter::PdfExportSettings & | settings | ||
) |
Exports the layout as a PDF to the filePath, using the specified export settings.
Returns a result code indicating whether the export was successful or an error was encountered.
Definition at line 528 of file qgslayoutexporter.cpp.
|
static |
Exports a layout iterator to a single PDF file, with the specified export settings.
The fileName argument gives the destination file name for the output PDF.
Returns a result code indicating whether the export was successful or an error was encountered. If an error was obtained then error will be set to the error description.
Definition at line 718 of file qgslayoutexporter.cpp.
|
static |
Exports a layout iterator to multiple PDF files, with the specified export settings.
The baseFilePath argument gives a base file path, which is modified by the iterator to obtain file paths for each iterator feature.
Returns a result code indicating whether the export was successful or an error was encountered. If an error was obtained then error will be set to the error description.
Definition at line 812 of file qgslayoutexporter.cpp.
QgsLayoutExporter::ExportResult QgsLayoutExporter::exportToSvg | ( | const QString & | filePath, |
const QgsLayoutExporter::SvgExportSettings & | settings | ||
) |
Exports the layout as an SVG to the filePath, using the specified export settings.
Returns a result code indicating whether the export was successful or an error was encountered.
Definition at line 981 of file qgslayoutexporter.cpp.
|
static |
Exports a layout iterator to SVG files, with the specified export settings.
The baseFilePath argument gives a base file path, which is modified by the iterator to obtain file paths for each iterator feature.
Returns a result code indicating whether the export was successful or an error was encountered. If an error was obtained then error will be set to the error description.
Definition at line 1155 of file qgslayoutexporter.cpp.
|
protectedvirtual |
Generates the file name for a page during export.
Subclasses can override this method to customize page file naming.
Definition at line 2044 of file qgslayoutexporter.cpp.
bool QgsLayoutExporter::georeferenceOutput | ( | const QString & | file, |
QgsLayoutItemMap * | referenceMap = nullptr , |
||
const QRectF & | exportRegion = QRectF() , |
||
double | dpi = -1 |
||
) | const |
Georeferences a file (image of PDF) exported from the layout.
The referenceMap argument specifies a map item to use for georeferencing. If left as nullptr
, the default layout QgsLayout::referenceMap() will be used.
The exportRegion argument can be set to a valid rectangle to indicate that only part of the layout was exported.
Similarly, the dpi can be set to the actual DPI of exported file, or left as -1 to use the layout's default DPI.
The function will return true
if the output was successfully georeferenced.
Definition at line 1595 of file qgslayoutexporter.cpp.
QMap< QString, QgsLabelingResults * > QgsLayoutExporter::labelingResults | ( | ) |
Returns the labeling results for all map items included in the export.
Map keys are the item UUIDs (see QgsLayoutItem::uuid()).
Ownership of the results remains with the layout exporter.
Definition at line 1206 of file qgslayoutexporter.cpp.
QgsLayout * QgsLayoutExporter::layout | ( | ) | const |
Returns the layout linked to this exporter.
Definition at line 159 of file qgslayoutexporter.cpp.
|
static |
Exports a layout iterator to a printer, with the specified export settings.
Returns a result code indicating whether the export was successful or an error was encountered. If an error was obtained then error will be set to the error description.
Definition at line 900 of file qgslayoutexporter.cpp.
QgsLayoutExporter::ExportResult QgsLayoutExporter::print | ( | QPrinter & | printer, |
const QgsLayoutExporter::PrintExportSettings & | settings | ||
) |
Prints the layout to a printer, using the specified export settings.
Returns a result code indicating whether the export was successful or an error was encountered.
Definition at line 861 of file qgslayoutexporter.cpp.
void QgsLayoutExporter::renderPage | ( | QPainter * | painter, |
int | page | ||
) | const |
Renders a full page to a destination painter.
The page argument specifies the page number to render. Page numbers are 0 based, such that the first page in a layout is page 0.
Definition at line 164 of file qgslayoutexporter.cpp.
QImage QgsLayoutExporter::renderPageToImage | ( | int | page, |
QSize | imageSize = QSize() , |
||
double | dpi = -1 |
||
) | const |
Renders a full page to an image.
The page argument specifies the page number to render. Page numbers are 0 based, such that the first page in a layout is page 0.
The optional imageSize parameter can specify the target image size, in pixels. It is the caller's responsibility to ensure that the ratio of the target image size matches the ratio of the corresponding layout page size.
The dpi parameter is an optional dpi override. Set to -1 to use the default layout print resolution. This parameter has no effect if imageSize is specified.
Returns the rendered image, or a null QImage if the image does not fit into available memory.
Definition at line 187 of file qgslayoutexporter.cpp.
PRIVATE void QgsLayoutExporter::renderRegion | ( | QPainter * | painter, |
const QRectF & | region | ||
) | const |
Renders a region from the layout to a painter.
This method can be used to render sections of pages rather than full pages.
Definition at line 256 of file qgslayoutexporter.cpp.
QImage QgsLayoutExporter::renderRegionToImage | ( | const QRectF & | region, |
QSize | imageSize = QSize() , |
||
double | dpi = -1 |
||
) | const |
Renders a region of the layout to an image.
This method can be used to render sections of pages rather than full pages.
The optional imageSize parameter can specify the target image size, in pixels. It is the caller's responsibility to ensure that the ratio of the target image size matches the ratio of the specified region of the layout.
The dpi parameter is an optional dpi override. Set to -1 to use the default layout print resolution. This parameter has no effect if imageSize is specified.
Returns the rendered image, or a null QImage if the image does not fit into available memory.
Definition at line 276 of file qgslayoutexporter.cpp.
|
static |
Returns true
if the specified layout contains visible items which have settings that require rasterization of the entire export layout in order to reproduce the desired appearance.
Definition at line 1958 of file qgslayoutexporter.cpp.
QMap< QString, QgsLabelingResults * > QgsLayoutExporter::takeLabelingResults | ( | ) |
Takes the labeling results for all map items included in the export.
Map keys are the item UUIDs (see QgsLayoutItem::uuid()).
Ownership of the results is transferred to the caller.
Definition at line 1211 of file qgslayoutexporter.cpp.
|
friend |
Definition at line 757 of file qgslayoutexporter.h.
|
friend |
Definition at line 758 of file qgslayoutexporter.h.