QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
qgsalgorithmlayoutatlastopdf.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmlayoutatlastopdf.cpp
3 ---------------------
4 begin : August 2020
5 copyright : (C) 2020 by Mathieu Pellerin
6 email : nirvn dot asia at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
19#include "qgslayout.h"
20#include "qgslayoutatlas.h"
21#include "qgslayoutitemmap.h"
22#include "qgslayoututils.h"
23#include "qgsprintlayout.h"
25#include "qgslayoutexporter.h"
26
28
29// QgsLayoutAtlasToPdfAlgorithmBase
30
31QStringList QgsLayoutAtlasToPdfAlgorithmBase::tags() const
32{
33 return QObject::tr( "layout,atlas,composer,composition,save" ).split( ',' );
34}
35
36QString QgsLayoutAtlasToPdfAlgorithmBase::group() const
37{
38 return QObject::tr( "Cartography" );
39}
40
41QString QgsLayoutAtlasToPdfAlgorithmBase::groupId() const
42{
43 return QStringLiteral( "cartography" );
44}
45
46Qgis::ProcessingAlgorithmFlags QgsLayoutAtlasToPdfAlgorithmBase::flags() const
47{
49}
50
51void QgsLayoutAtlasToPdfAlgorithmBase::initAlgorithm( const QVariantMap & )
52{
53 addParameter( new QgsProcessingParameterLayout( QStringLiteral( "LAYOUT" ), QObject::tr( "Atlas layout" ) ) );
54
55 addParameter( new QgsProcessingParameterVectorLayer( QStringLiteral( "COVERAGE_LAYER" ), QObject::tr( "Coverage layer" ), QList< int >(), QVariant(), true ) );
56 addParameter( new QgsProcessingParameterExpression( QStringLiteral( "FILTER_EXPRESSION" ), QObject::tr( "Filter expression" ), QString(), QStringLiteral( "COVERAGE_LAYER" ), true ) );
57 addParameter( new QgsProcessingParameterExpression( QStringLiteral( "SORTBY_EXPRESSION" ), QObject::tr( "Sort expression" ), QString(), QStringLiteral( "COVERAGE_LAYER" ), true ) );
58 addParameter( new QgsProcessingParameterBoolean( QStringLiteral( "SORTBY_REVERSE" ), QObject::tr( "Reverse sort order (used when a sort expression is provided)" ), false, true ) );
59
60 std::unique_ptr< QgsProcessingParameterMultipleLayers > layersParam = std::make_unique< QgsProcessingParameterMultipleLayers>( QStringLiteral( "LAYERS" ), QObject::tr( "Map layers to assign to unlocked map item(s)" ), Qgis::ProcessingSourceType::MapLayer, QVariant(), true );
61 layersParam->setFlags( layersParam->flags() | Qgis::ProcessingParameterFlag::Advanced );
62 addParameter( layersParam.release() );
63
64 std::unique_ptr< QgsProcessingParameterNumber > dpiParam = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral( "DPI" ), QObject::tr( "DPI (leave blank for default layout DPI)" ), Qgis::ProcessingNumberParameterType::Double, QVariant(), true, 0 );
65 dpiParam->setFlags( dpiParam->flags() | Qgis::ProcessingParameterFlag::Advanced );
66 addParameter( dpiParam.release() );
67
68 std::unique_ptr< QgsProcessingParameterBoolean > forceVectorParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral( "FORCE_VECTOR" ), QObject::tr( "Always export as vectors" ), false );
69 forceVectorParam->setFlags( forceVectorParam->flags() | Qgis::ProcessingParameterFlag::Advanced );
70 addParameter( forceVectorParam.release() );
71
72 std::unique_ptr< QgsProcessingParameterBoolean > forceRasterParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral( "FORCE_RASTER" ), QObject::tr( "Always export as raster" ), false );
73 forceRasterParam->setFlags( forceRasterParam->flags() | Qgis::ProcessingParameterFlag::Advanced );
74 addParameter( forceRasterParam.release() );
75
76 std::unique_ptr< QgsProcessingParameterBoolean > appendGeorefParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral( "GEOREFERENCE" ), QObject::tr( "Append georeference information" ), true );
77 appendGeorefParam->setFlags( appendGeorefParam->flags() | Qgis::ProcessingParameterFlag::Advanced );
78 addParameter( appendGeorefParam.release() );
79
80 std::unique_ptr< QgsProcessingParameterBoolean > exportRDFParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral( "INCLUDE_METADATA" ), QObject::tr( "Export RDF metadata (title, author, etc.)" ), true );
81 exportRDFParam->setFlags( exportRDFParam->flags() | Qgis::ProcessingParameterFlag::Advanced );
82 addParameter( exportRDFParam.release() );
83
84 std::unique_ptr< QgsProcessingParameterBoolean > disableTiled = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral( "DISABLE_TILED" ), QObject::tr( "Disable tiled raster layer exports" ), false );
85 disableTiled->setFlags( disableTiled->flags() | Qgis::ProcessingParameterFlag::Advanced );
86 addParameter( disableTiled.release() );
87
88 std::unique_ptr< QgsProcessingParameterBoolean > simplify = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral( "SIMPLIFY" ), QObject::tr( "Simplify geometries to reduce output file size" ), true );
89 simplify->setFlags( simplify->flags() | Qgis::ProcessingParameterFlag::Advanced );
90 addParameter( simplify.release() );
91
92 const QStringList textExportOptions
93 {
94 QObject::tr( "Always Export Text as Paths (Recommended)" ),
95 QObject::tr( "Always Export Text as Text Objects" )
96 };
97
98 std::unique_ptr< QgsProcessingParameterEnum > textFormat = std::make_unique< QgsProcessingParameterEnum >( QStringLiteral( "TEXT_FORMAT" ), QObject::tr( "Text export" ), textExportOptions, false, 0 );
99 textFormat->setFlags( textFormat->flags() | Qgis::ProcessingParameterFlag::Advanced );
100 addParameter( textFormat.release() );
101
102 const QStringList imageCompressionOptions
103 {
104 QObject::tr( "Lossy (JPEG)" ),
105 QObject::tr( "Lossless" )
106 };
107
108 std::unique_ptr< QgsProcessingParameterEnum > imageCompression = std::make_unique< QgsProcessingParameterEnum >( QStringLiteral( "IMAGE_COMPRESSION" ), QObject::tr( "Image compression" ), imageCompressionOptions, false, 0 );
109 imageCompression->setFlags( imageCompression->flags() | Qgis::ProcessingParameterFlag::Advanced );
110 addParameter( imageCompression.release() );
111}
112
113QVariantMap QgsLayoutAtlasToPdfAlgorithmBase::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
114{
115 // this needs to be done in main thread, layouts are not thread safe
116 QgsPrintLayout *l = parameterAsLayout( parameters, QStringLiteral( "LAYOUT" ), context );
117 if ( !l )
118 throw QgsProcessingException( QObject::tr( "Cannot find layout with name \"%1\"" ).arg( parameters.value( QStringLiteral( "LAYOUT" ) ).toString() ) );
119
120 std::unique_ptr< QgsPrintLayout > layout( l->clone() );
121 QgsLayoutAtlas *atlas = layout->atlas();
122
123 QString expression, error;
124 QgsVectorLayer *layer = parameterAsVectorLayer( parameters, QStringLiteral( "COVERAGE_LAYER" ), context );
125 if ( layer )
126 {
127 atlas->setEnabled( true );
128 atlas->setCoverageLayer( layer );
129
130 expression = parameterAsString( parameters, QStringLiteral( "FILTER_EXPRESSION" ), context );
131 atlas->setFilterExpression( expression, error );
132 atlas->setFilterFeatures( !expression.isEmpty() && error.isEmpty() );
133 if ( !expression.isEmpty() && !error.isEmpty() )
134 {
135 throw QgsProcessingException( QObject::tr( "Error setting atlas filter expression" ) );
136 }
137 error.clear();
138
139 expression = parameterAsString( parameters, QStringLiteral( "SORTBY_EXPRESSION" ), context );
140 if ( !expression.isEmpty() )
141 {
142 const bool sortByReverse = parameterAsBool( parameters, QStringLiteral( "SORTBY_REVERSE" ), context );
143 atlas->setSortFeatures( true );
144 atlas->setSortExpression( expression );
145 atlas->setSortAscending( !sortByReverse );
146 }
147 else
148 {
149 atlas->setSortFeatures( false );
150 }
151 }
152 else if ( !atlas->enabled() )
153 {
154 throw QgsProcessingException( QObject::tr( "Selected layout does not have atlas functionality enabled" ) );
155 }
156
157 const QgsLayoutExporter exporter( layout.get() );
159
160 if ( parameters.value( QStringLiteral( "DPI" ) ).isValid() )
161 {
162 settings.dpi = parameterAsDouble( parameters, QStringLiteral( "DPI" ), context );
163 }
164 settings.forceVectorOutput = parameterAsBool( parameters, QStringLiteral( "FORCE_VECTOR" ), context );
165 settings.rasterizeWholeImage = parameterAsBool( parameters, QStringLiteral( "FORCE_RASTER" ), context );
166 settings.appendGeoreference = parameterAsBool( parameters, QStringLiteral( "GEOREFERENCE" ), context );
167 settings.exportMetadata = parameterAsBool( parameters, QStringLiteral( "INCLUDE_METADATA" ), context );
168 settings.simplifyGeometries = parameterAsBool( parameters, QStringLiteral( "SIMPLIFY" ), context );
169 settings.textRenderFormat = parameterAsEnum( parameters, QStringLiteral( "TEXT_FORMAT" ), context ) == 0 ? Qgis::TextRenderFormat::AlwaysOutlines : Qgis::TextRenderFormat::AlwaysText;
170
171 if ( parameterAsBool( parameters, QStringLiteral( "DISABLE_TILED" ), context ) )
173 else
174 settings.flags = settings.flags & ~QgsLayoutRenderContext::FlagDisableTiledRasterLayerRenders;
175
176 if ( parameterAsEnum( parameters, QStringLiteral( "IMAGE_COMPRESSION" ), context ) == 1 )
178 else
179 settings.flags = settings.flags & ~QgsLayoutRenderContext::FlagLosslessImageRendering;
180
181 settings.predefinedMapScales = QgsLayoutUtils::predefinedScales( layout.get() );
182
183 const QList< QgsMapLayer * > layers = parameterAsLayerList( parameters, QStringLiteral( "LAYERS" ), context );
184 if ( layers.size() > 0 )
185 {
186 const QList<QGraphicsItem *> items = layout->items();
187 for ( QGraphicsItem *graphicsItem : items )
188 {
189 QgsLayoutItem *item = dynamic_cast<QgsLayoutItem *>( graphicsItem );
190 QgsLayoutItemMap *map = dynamic_cast<QgsLayoutItemMap *>( item );
191 if ( map && !map->followVisibilityPreset() && !map->keepLayerSet() )
192 {
193 map->setKeepLayerSet( true );
194 map->setLayers( layers );
195 }
196 }
197 }
198
199 return exportAtlas( atlas, exporter, settings, parameters, context, feedback );
200}
201
202//
203// QgsLayoutAtlasToPdfAlgorithm
204//
205
206QString QgsLayoutAtlasToPdfAlgorithm::name() const
207{
208 return QStringLiteral( "atlaslayouttopdf" );
209}
210
211QString QgsLayoutAtlasToPdfAlgorithm::displayName() const
212{
213 return QObject::tr( "Export atlas layout as PDF (single file)" );
214}
215
216QString QgsLayoutAtlasToPdfAlgorithm::shortDescription() const
217{
218 return QObject::tr( "Exports an atlas layout as a single PDF file." );
219}
220
221QString QgsLayoutAtlasToPdfAlgorithm::shortHelpString() const
222{
223 return QObject::tr( "This algorithm outputs an atlas layout as a single PDF file.\n\n"
224 "If a coverage layer is set, the selected layout's atlas settings exposed in this algorithm "
225 "will be overwritten. In this case, an empty filter or sort by expression will turn those "
226 "settings off." );
227}
228
229void QgsLayoutAtlasToPdfAlgorithm::initAlgorithm( const QVariantMap & )
230{
231 QgsLayoutAtlasToPdfAlgorithmBase::initAlgorithm();
232 addParameter( new QgsProcessingParameterFileDestination( QStringLiteral( "OUTPUT" ), QObject::tr( "PDF file" ), QObject::tr( "PDF Format" ) + " (*.pdf *.PDF)" ) );
233}
234
235QgsLayoutAtlasToPdfAlgorithm *QgsLayoutAtlasToPdfAlgorithm::createInstance() const
236{
237 return new QgsLayoutAtlasToPdfAlgorithm();
238}
239
240QVariantMap QgsLayoutAtlasToPdfAlgorithm::exportAtlas( QgsLayoutAtlas *atlas, const QgsLayoutExporter &exporter, const QgsLayoutExporter::PdfExportSettings &settings,
241 const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
242{
243 Q_UNUSED( exporter )
244
245 const QString dest = parameterAsFileOutput( parameters, QStringLiteral( "OUTPUT" ), context );
246
247 QString error;
248 if ( atlas->updateFeatures() )
249 {
250 feedback->pushInfo( QObject::tr( "Exporting %n atlas feature(s)", "", atlas->count() ) );
251 switch ( QgsLayoutExporter::exportToPdf( atlas, dest, settings, error, feedback ) )
252 {
254 {
255 feedback->pushInfo( QObject::tr( "Successfully exported atlas to %1" ).arg( QDir::toNativeSeparators( dest ) ) );
256 break;
257 }
258
260 throw QgsProcessingException( !error.isEmpty() ? error : QObject::tr( "Cannot write to %1.\n\nThis file may be open in another application." ).arg( QDir::toNativeSeparators( dest ) ) );
261
263 throw QgsProcessingException( !error.isEmpty() ? error : QObject::tr( "Could not create print device." ) );
264
266 throw QgsProcessingException( !error.isEmpty() ? error : QObject::tr( "Trying to create the image "
267 "resulted in a memory overflow.\n\n"
268 "Please try a lower resolution or a smaller paper size." ) );
269
271 throw QgsProcessingException( !error.isEmpty() ? error : QObject::tr( "Error encountered while exporting atlas." ) );
272
275 // no meaning for PDF exports, will not be encountered
276 break;
277 }
278 }
279 else
280 {
281 feedback->reportError( QObject::tr( "No atlas features found" ) );
282 }
283
284 feedback->setProgress( 100 );
285
286 QVariantMap outputs;
287 outputs.insert( QStringLiteral( "OUTPUT" ), dest );
288 return outputs;
289}
290
291//
292// QgsLayoutAtlasToMultiplePdfAlgorithm
293//
294
295QString QgsLayoutAtlasToMultiplePdfAlgorithm::name() const
296{
297 return QStringLiteral( "atlaslayouttomultiplepdf" );
298}
299
300QString QgsLayoutAtlasToMultiplePdfAlgorithm::displayName() const
301{
302 return QObject::tr( "Export atlas layout as PDF (multiple files)" );
303}
304
305QString QgsLayoutAtlasToMultiplePdfAlgorithm::shortDescription() const
306{
307 return QObject::tr( "Exports an atlas layout to multiple PDF files." );
308}
309
310QString QgsLayoutAtlasToMultiplePdfAlgorithm::shortHelpString() const
311{
312 return QObject::tr( "This algorithm outputs an atlas layout to multiple PDF files.\n\n"
313 "If a coverage layer is set, the selected layout's atlas settings exposed in this algorithm "
314 "will be overwritten. In this case, an empty filter or sort by expression will turn those "
315 "settings off.\n"
316 );
317}
318
319void QgsLayoutAtlasToMultiplePdfAlgorithm::initAlgorithm( const QVariantMap & )
320{
321 QgsLayoutAtlasToPdfAlgorithmBase::initAlgorithm();
322 addParameter( new QgsProcessingParameterExpression( QStringLiteral( "OUTPUT_FILENAME" ), QObject::tr( "Output filename" ), QString(), QStringLiteral( "COVERAGE_LAYER" ), true ) );
323 addParameter( new QgsProcessingParameterFile( QStringLiteral( "OUTPUT_FOLDER" ), QObject::tr( "Output folder" ), Qgis::ProcessingFileParameterBehavior::Folder ) );
324}
325
326QgsLayoutAtlasToMultiplePdfAlgorithm *QgsLayoutAtlasToMultiplePdfAlgorithm::createInstance() const
327{
328 return new QgsLayoutAtlasToMultiplePdfAlgorithm();
329}
330
331QVariantMap QgsLayoutAtlasToMultiplePdfAlgorithm::exportAtlas( QgsLayoutAtlas *atlas, const QgsLayoutExporter &exporter, const QgsLayoutExporter::PdfExportSettings &settings,
332 const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
333{
334 Q_UNUSED( exporter )
335
336 QString error;
337
338 const QString filename = parameterAsString( parameters, QStringLiteral( "OUTPUT_FILENAME" ), context );
339 const QString destFolder = parameterAsFile( parameters, QStringLiteral( "OUTPUT_FOLDER" ), context );
340
341 // the "atlas.pdf" part will be overridden, only the folder is important
342 const QString dest = QStringLiteral( "%1/atlas.pdf" ).arg( destFolder );
343
344 if ( atlas->updateFeatures() )
345 {
346 feedback->pushInfo( QObject::tr( "Exporting %n atlas feature(s)", "", atlas->count() ) );
347
349 if ( atlas->filenameExpression().isEmpty() && filename.isEmpty() )
350 {
351 atlas->setFilenameExpression( QStringLiteral( "'output_'||@atlas_featurenumber" ), error );
352 }
353 else if ( !filename.isEmpty() )
354 {
355 if ( !atlas->setFilenameExpression( filename, error ) )
356 {
357 throw QgsProcessingException( QObject::tr( "Output file name expression is not valid: %1" ).arg( error ) );
358 }
359 }
360
361 result = QgsLayoutExporter::exportToPdfs( atlas, dest, settings, error, feedback );
362
363 switch ( result )
364 {
366 {
367 feedback->pushInfo( QObject::tr( "Successfully exported atlas to %1" ).arg( QDir::toNativeSeparators( destFolder ) ) );
368 break;
369 }
370
372 throw QgsProcessingException( !error.isEmpty() ? error : QObject::tr( "Cannot write to %1.\n\nThis file may be open in another application." ).arg( QDir::toNativeSeparators( dest ) ) );
373
375 throw QgsProcessingException( !error.isEmpty() ? error : QObject::tr( "Could not create print device." ) );
376
378 throw QgsProcessingException( !error.isEmpty() ? error : QObject::tr( "Trying to create the image "
379 "resulted in a memory overflow.\n\n"
380 "Please try a lower resolution or a smaller paper size." ) );
381
383 throw QgsProcessingException( !error.isEmpty() ? error : QObject::tr( "Error encountered while exporting atlas." ) );
384
387 // no meaning for PDF exports, will not be encountered
388 break;
389 }
390 }
391 else
392 {
393 feedback->reportError( QObject::tr( "No atlas features found" ) );
394 }
395
396 feedback->setProgress( 100 );
397
398 QVariantMap outputs;
399 outputs.insert( QStringLiteral( "OUTPUT_FOLDER" ), destFolder );
400 return outputs;
401}
402
404
@ MapLayer
Any map layer type (raster, vector, mesh, point cloud, annotation or plugin layer)
@ Folder
Parameter is a folder.
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3076
@ AlwaysOutlines
Always render text using path objects (AKA outlines/curves). This setting guarantees the best quality...
@ AlwaysText
Always render text as text objects. While this mode preserves text objects as text for post-processin...
@ NoThreading
Algorithm is not thread safe and cannot be run in a background thread, e.g. for algorithms which mani...
@ RequiresProject
The algorithm requires that a valid QgsProject is available from the processing context in order to e...
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
void setProgress(double progress)
Sets the current progress for the feedback object.
Definition qgsfeedback.h:61
Class used to render QgsLayout as an atlas, by iterating over the features from an associated vector ...
QString filenameExpression() const
Returns the filename expression used for generating output filenames for each atlas page.
void setCoverageLayer(QgsVectorLayer *layer)
Sets the coverage layer to use for the atlas features.
bool setFilterExpression(const QString &expression, QString &errorString)
Sets the expression used for filtering features in the coverage layer.
void setSortAscending(bool ascending)
Sets whether features should be sorted in an ascending order.
void setEnabled(bool enabled)
Sets whether the atlas is enabled.
bool enabled() const
Returns whether the atlas generation is enabled.
bool setFilenameExpression(const QString &expression, QString &errorString)
Sets the filename expression used for generating output filenames for each atlas page.
void setSortFeatures(bool enabled)
Sets whether features should be sorted in the atlas.
int count() const override
Returns the number of features to iterate over.
void setSortExpression(const QString &expression)
Sets the expression (or field name) to use for sorting features.
void setFilterFeatures(bool filtered)
Sets whether features should be filtered in the coverage layer.
int updateFeatures()
Requeries the current atlas coverage layer and applies filtering and sorting.
Handles rendering and exports of layouts to various formats.
ExportResult exportToPdf(const QString &filePath, const QgsLayoutExporter::PdfExportSettings &settings)
Exports the layout as a PDF to the filePath, using the specified export settings.
ExportResult
Result codes for exporting layouts.
@ Canceled
Export was canceled.
@ MemoryError
Unable to allocate memory required to export.
@ PrintError
Could not start printing to destination device.
@ IteratorError
Error iterating over layout.
@ FileError
Could not write to destination file, likely due to a lock held by another application.
@ Success
Export was successful.
@ SvgLayerError
Could not create layered SVG file.
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.
Layout graphical items for displaying a map.
bool keepLayerSet() const
Returns whether a stored layer set should be used or the current layer set from the project associate...
void setKeepLayerSet(bool enabled)
Sets whether the stored layer set should be used or the current layer set of the associated project.
bool followVisibilityPreset() const
Returns whether the map should follow a map theme.
void setLayers(const QList< QgsMapLayer * > &layers)
Sets the stored layers set.
Base class for graphical items within a QgsLayout.
Stores information relating to the current rendering settings for a layout.
@ FlagLosslessImageRendering
Render images losslessly whenever possible, instead of the default lossy jpeg rendering used for some...
@ FlagDisableTiledRasterLayerRenders
If set, then raster layers will not be drawn as separate tiles. This may improve the appearance in ex...
static QVector< double > predefinedScales(const QgsLayout *layout)
Returns a list of predefined scales associated with a layout.
Print layout, a QgsLayout subclass for static or atlas-based layouts.
QgsPrintLayout * clone() const override
Creates a clone of the layout.
virtual Qgis::ProcessingAlgorithmFlags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
Contains information about the context in which a processing algorithm is executed.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
virtual void pushInfo(const QString &info)
Pushes a general informational message from the algorithm.
virtual void reportError(const QString &error, bool fatalError=false)
Reports that the algorithm encountered an error while executing.
A boolean parameter for processing algorithms.
An expression parameter for processing algorithms.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
An input file or folder parameter for processing algorithms.
A print layout parameter, allowing users to select a print layout.
A vector layer (with or without geometry) parameter for processing algorithms.
Represents a vector layer which manages a vector based data sets.
Contains settings relating to exporting layouts to PDF.
bool forceVectorOutput
Set to true to force vector object exports, even when the resultant appearance will differ from the l...
bool rasterizeWholeImage
Set to true to force whole layout to be rasterized while exporting.
bool exportMetadata
Indicates whether PDF export should include metadata generated from the layout's project's metadata.
bool appendGeoreference
Indicates whether PDF export should append georeference data.
QgsLayoutRenderContext::Flags flags
Layout context flags, which control how the export will be created.
double dpi
Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.
QVector< qreal > predefinedMapScales
A list of predefined scales to use with the layout.
bool simplifyGeometries
Indicates whether vector geometries should be simplified to avoid redundant extraneous detail,...
Qgis::TextRenderFormat textRenderFormat
Text rendering format, which controls how text should be rendered in the export (e....