QgsLayoutExporter::PdfExportSettings struct

Contains settings relating to exporting layouts to PDF.

Contents

Constructors, destructors, conversion operators

PdfExportSettings()
Constructor for PdfExportSettings.

Public variables

double dpi
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.
bool exportMetadata
Indicates whether PDF export should include metadata generated from the layout's project's metadata.
QgsLayoutRenderContext::Flags flags
Layout context flags, which control how the export will be created.
bool forceVectorOutput
Set to true to force vector object exports, even when the resultant appearance will differ from the layout.
bool rasterizeWholeImage
Set to true to force whole layout to be rasterized while exporting.
QgsRenderContext::TextRenderFormat textRenderFormat
Text rendering format, which controls how text should be rendered in the export (e.g.

Variable documentation

bool QgsLayoutExporter::PdfExportSettings::exportMetadata

Indicates whether PDF export should include metadata generated from the layout's project's metadata.

bool QgsLayoutExporter::PdfExportSettings::forceVectorOutput

Set to true to force vector object exports, even when the resultant appearance will differ from the layout.

If false, some items may be rasterized in order to maintain their correct appearance in the output.

This option is mutually exclusive with rasterizeWholeImage.

bool QgsLayoutExporter::PdfExportSettings::rasterizeWholeImage

Set to true to force whole layout to be rasterized while exporting.

This option is mutually exclusive with forceVectorOutput.

QgsRenderContext::TextRenderFormat QgsLayoutExporter::PdfExportSettings::textRenderFormat

Text rendering format, which controls how text should be rendered in the export (e.g.

as paths or real text objects).