|
QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
Contains settings relating to exporting layouts to PDF. More...
#include <qgslayoutexporter.h>
Public Member Functions | |
| PdfExportSettings () | |
| Constructor for PdfExportSettings. More... | |
Public Attributes | |
| bool | appendGeoreference = true |
| Indicates whether PDF export should append georeference data. More... | |
| double | dpi = -1 |
| Resolution to export layout at. If dpi <= 0 the default layout dpi will be used. More... | |
| bool | exportLayersAsSeperateFiles = false |
true if individual layers from the layout should be rendered to separate PDF files. More... | |
| bool | exportMetadata = true |
| Indicates whether PDF export should include metadata generated from the layout's project's metadata. More... | |
| QStringList | exportThemes |
| Optional list of map themes to export as GeoPDF layer groups. More... | |
| QgsLayoutRenderContext::Flags | flags = QgsLayoutRenderContext::Flags() |
| Layout context flags, which control how the export will be created. More... | |
| bool | forceVectorOutput = false |
Set to true to force vector object exports, even when the resultant appearance will differ from the layout. More... | |
| bool | includeGeoPdfFeatures = true |
true if feature vector information (such as attributes) should be exported during GeoPDF exports. More... | |
| QVector< qreal > | predefinedMapScales |
| A list of predefined scales to use with the layout. More... | |
| bool | rasterizeWholeImage = false |
Set to true to force whole layout to be rasterized while exporting. More... | |
| bool | simplifyGeometries = true |
| Indicates whether vector geometries should be simplified to avoid redundant extraneous detail, such as vertices which are not visible at the specified dpi of the output. More... | |
| QgsRenderContext::TextRenderFormat | textRenderFormat = QgsRenderContext::TextFormatAlwaysOutlines |
| Text rendering format, which controls how text should be rendered in the export (e.g. More... | |
| bool | useIso32000ExtensionFormatGeoreferencing = true |
true if ISO3200 extension format georeferencing should be used. More... | |
| bool | useOgcBestPracticeFormatGeoreferencing = false |
true if OGC "best practice" format georeferencing should be used. More... | |
| bool | writeGeoPdf = false |
true if GeoPDF files should be created, instead of normal PDF files. More... | |
Contains settings relating to exporting layouts to PDF.
Definition at line 251 of file qgslayoutexporter.h.
|
inline |
Constructor for PdfExportSettings.
Definition at line 254 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::appendGeoreference = true |
Indicates whether PDF export should append georeference data.
Definition at line 282 of file qgslayoutexporter.h.
| double QgsLayoutExporter::PdfExportSettings::dpi = -1 |
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.
Definition at line 259 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::exportLayersAsSeperateFiles = false |
true if individual layers from the layout should be rendered to separate PDF files.
This option allows for separation of logic layout layers to individual PDF files. For instance, if this option is true, then a separate PDF file will be created per layer per map item in the layout. Additionally, separate PDF files may be created for other complex layout items, resulting in a set of PDF files which contain logical atomic components of the layout.
This option is designed to allow the PDF files to be composited back together in an external application (e.g. Adobe Illustrator) as a non-QGIS, post-production step.
Definition at line 339 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::exportMetadata = true |
Indicates whether PDF export should include metadata generated from the layout's project's metadata.
Definition at line 290 of file qgslayoutexporter.h.
| QStringList QgsLayoutExporter::PdfExportSettings::exportThemes |
Optional list of map themes to export as GeoPDF layer groups.
If set, map item's which are not assigned a specific map theme will iterate through all listed themes and a GeoPDF layer group will be created for each.
If PdfExportSettings::writeGeoPdf is false than this option has no effect.
Definition at line 377 of file qgslayoutexporter.h.
| QgsLayoutRenderContext::Flags QgsLayoutExporter::PdfExportSettings::flags = QgsLayoutRenderContext::Flags() |
Layout context flags, which control how the export will be created.
Definition at line 295 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::forceVectorOutput = false |
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.
Definition at line 275 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::includeGeoPdfFeatures = true |
true if feature vector information (such as attributes) should be exported during GeoPDF exports.
If PdfExportSettings::writeGeoPdf is false than this option has no effect.
Definition at line 367 of file qgslayoutexporter.h.
| QVector<qreal> QgsLayoutExporter::PdfExportSettings::predefinedMapScales |
A list of predefined scales to use with the layout.
This is used for maps which are set to the predefined atlas scaling mode.
Definition at line 384 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::rasterizeWholeImage = false |
Set to true to force whole layout to be rasterized while exporting.
This option is mutually exclusive with forceVectorOutput.
Definition at line 266 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::simplifyGeometries = true |
Indicates whether vector geometries should be simplified to avoid redundant extraneous detail, such as vertices which are not visible at the specified dpi of the output.
Definition at line 311 of file qgslayoutexporter.h.
| QgsRenderContext::TextRenderFormat QgsLayoutExporter::PdfExportSettings::textRenderFormat = QgsRenderContext::TextFormatAlwaysOutlines |
Text rendering format, which controls how text should be rendered in the export (e.g.
as paths or real text objects).
Definition at line 303 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::useIso32000ExtensionFormatGeoreferencing = true |
true if ISO3200 extension format georeferencing should be used.
This is a recommended setting which results in Geospatial PDF files compatible with the built-in Acrobat geospatial tools.
If PdfExportSettings::writeGeoPdf is false than this option has no effect.
Definition at line 349 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::useOgcBestPracticeFormatGeoreferencing = false |
true if OGC "best practice" format georeferencing should be used.
If PdfExportSettings::writeGeoPdf is false than this option has no effect.
Definition at line 360 of file qgslayoutexporter.h.
| bool QgsLayoutExporter::PdfExportSettings::writeGeoPdf = false |
true if GeoPDF files should be created, instead of normal PDF files.
Whilst GeoPDF files can include some desirable properties like the ability to interactively query map features, they also can result in lower-quality output files, or forced rasterization of layers.
Definition at line 324 of file qgslayoutexporter.h.
1.8.20