31QStringList QgsLayoutAtlasToPdfAlgorithmBase::tags()
const
33 return QObject::tr(
"layout,atlas,composer,composition,save" ).split(
',' );
36QString QgsLayoutAtlasToPdfAlgorithmBase::group()
const
38 return QObject::tr(
"Cartography" );
41QString QgsLayoutAtlasToPdfAlgorithmBase::groupId()
const
43 return QStringLiteral(
"cartography" );
46QgsProcessingAlgorithm::Flags QgsLayoutAtlasToPdfAlgorithmBase::flags()
const
51void QgsLayoutAtlasToPdfAlgorithmBase::initAlgorithm(
const QVariantMap & )
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 ) );
60 std::unique_ptr< QgsProcessingParameterMultipleLayers > layersParam = std::make_unique< QgsProcessingParameterMultipleLayers>( QStringLiteral(
"LAYERS" ), QObject::tr(
"Map layers to assign to unlocked map item(s)" ),
QgsProcessing::TypeMapLayer, QVariant(),
true );
62 addParameter( layersParam.release() );
64 std::unique_ptr< QgsProcessingParameterNumber > dpiParam = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral(
"DPI" ), QObject::tr(
"DPI (leave blank for default layout DPI)" ),
QgsProcessingParameterNumber::Double, QVariant(),
true, 0 );
66 addParameter( dpiParam.release() );
68 std::unique_ptr< QgsProcessingParameterBoolean > forceVectorParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"FORCE_VECTOR" ), QObject::tr(
"Always export as vectors" ),
false );
70 addParameter( forceVectorParam.release() );
72 std::unique_ptr< QgsProcessingParameterBoolean > forceRasterParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"FORCE_RASTER" ), QObject::tr(
"Always export as raster" ),
false );
74 addParameter( forceRasterParam.release() );
76 std::unique_ptr< QgsProcessingParameterBoolean > appendGeorefParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"GEOREFERENCE" ), QObject::tr(
"Append georeference information" ),
true );
78 addParameter( appendGeorefParam.release() );
80 std::unique_ptr< QgsProcessingParameterBoolean > exportRDFParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"INCLUDE_METADATA" ), QObject::tr(
"Export RDF metadata (title, author, etc.)" ),
true );
82 addParameter( exportRDFParam.release() );
84 std::unique_ptr< QgsProcessingParameterBoolean > disableTiled = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"DISABLE_TILED" ), QObject::tr(
"Disable tiled raster layer exports" ),
false );
86 addParameter( disableTiled.release() );
88 std::unique_ptr< QgsProcessingParameterBoolean > simplify = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"SIMPLIFY" ), QObject::tr(
"Simplify geometries to reduce output file size" ),
true );
90 addParameter( simplify.release() );
92 const QStringList textExportOptions
94 QObject::tr(
"Always Export Text as Paths (Recommended)" ),
95 QObject::tr(
"Always Export Text as Text Objects" )
98 std::unique_ptr< QgsProcessingParameterEnum > textFormat = std::make_unique< QgsProcessingParameterEnum >( QStringLiteral(
"TEXT_FORMAT" ), QObject::tr(
"Text export" ), textExportOptions,
false, 0 );
100 addParameter( textFormat.release() );
102 const QStringList imageCompressionOptions
104 QObject::tr(
"Lossy (JPEG)" ),
105 QObject::tr(
"Lossless" )
108 std::unique_ptr< QgsProcessingParameterEnum > imageCompression = std::make_unique< QgsProcessingParameterEnum >( QStringLiteral(
"IMAGE_COMPRESSION" ), QObject::tr(
"Image compression" ), imageCompressionOptions,
false, 0 );
110 addParameter( imageCompression.release() );
116 QgsPrintLayout *l = parameterAsLayout( parameters, QStringLiteral(
"LAYOUT" ), context );
118 throw QgsProcessingException( QObject::tr(
"Cannot find layout with name \"%1\"" ).arg( parameters.value( QStringLiteral(
"LAYOUT" ) ).toString() ) );
120 std::unique_ptr< QgsPrintLayout > layout( l->
clone() );
123 QString expression, error;
124 QgsVectorLayer *layer = parameterAsVectorLayer( parameters, QStringLiteral(
"COVERAGE_LAYER" ), context );
130 expression = parameterAsString( parameters, QStringLiteral(
"FILTER_EXPRESSION" ), context );
133 if ( !expression.isEmpty() && !error.isEmpty() )
139 expression = parameterAsString( parameters, QStringLiteral(
"SORTBY_EXPRESSION" ), context );
140 if ( !expression.isEmpty() )
142 const bool sortByReverse = parameterAsBool( parameters, QStringLiteral(
"SORTBY_REVERSE" ), context );
154 throw QgsProcessingException( QObject::tr(
"Selected layout does not have atlas functionality enabled" ) );
160 if ( parameters.value( QStringLiteral(
"DPI" ) ).isValid() )
162 settings.
dpi = parameterAsDouble( parameters, QStringLiteral(
"DPI" ), context );
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 );
171 if ( parameterAsBool( parameters, QStringLiteral(
"DISABLE_TILED" ), context ) )
176 if ( parameterAsEnum( parameters, QStringLiteral(
"IMAGE_COMPRESSION" ), context ) == 1 )
183 const QList< QgsMapLayer * > layers = parameterAsLayerList( parameters, QStringLiteral(
"LAYERS" ), context );
184 if ( layers.size() > 0 )
186 const QList<QGraphicsItem *> items = layout->items();
187 for ( QGraphicsItem *graphicsItem : items )
199 return exportAtlas( atlas, exporter, settings, parameters, context, feedback );
206QString QgsLayoutAtlasToPdfAlgorithm::name()
const
208 return QStringLiteral(
"atlaslayouttopdf" );
211QString QgsLayoutAtlasToPdfAlgorithm::displayName()
const
213 return QObject::tr(
"Export atlas layout as PDF (single file)" );
216QString QgsLayoutAtlasToPdfAlgorithm::shortDescription()
const
218 return QObject::tr(
"Exports an atlas layout as a single PDF file." );
221QString QgsLayoutAtlasToPdfAlgorithm::shortHelpString()
const
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 "
229void QgsLayoutAtlasToPdfAlgorithm::initAlgorithm(
const QVariantMap & )
231 QgsLayoutAtlasToPdfAlgorithmBase::initAlgorithm();
235QgsLayoutAtlasToPdfAlgorithm *QgsLayoutAtlasToPdfAlgorithm::createInstance()
const
237 return new QgsLayoutAtlasToPdfAlgorithm();
245 const QString dest = parameterAsFileOutput( parameters, QStringLiteral(
"OUTPUT" ), context );
250 feedback->
pushInfo( QObject::tr(
"Exporting %n atlas feature(s)",
"", atlas->
count() ) );
255 feedback->
pushInfo( QObject::tr(
"Successfully exported atlas to %1" ).arg( QDir::toNativeSeparators( dest ) ) );
260 throw QgsProcessingException( QObject::tr(
"Cannot write to %1.\n\nThis file may be open in another application." ).arg( QDir::toNativeSeparators( dest ) ) );
267 "resulted in a memory overflow.\n\n"
268 "Please try a lower resolution or a smaller paper size." ) );
281 feedback->
reportError( QObject::tr(
"No atlas features found" ) );
287 outputs.insert( QStringLiteral(
"OUTPUT" ), dest );
295QString QgsLayoutAtlasToMultiplePdfAlgorithm::name()
const
297 return QStringLiteral(
"atlaslayouttomultiplepdf" );
300QString QgsLayoutAtlasToMultiplePdfAlgorithm::displayName()
const
302 return QObject::tr(
"Export atlas layout as PDF (multiple files)" );
305QString QgsLayoutAtlasToMultiplePdfAlgorithm::shortDescription()
const
307 return QObject::tr(
"Exports an atlas layout to multiple PDF files." );
310QString QgsLayoutAtlasToMultiplePdfAlgorithm::shortHelpString()
const
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 "
319void QgsLayoutAtlasToMultiplePdfAlgorithm::initAlgorithm(
const QVariantMap & )
321 QgsLayoutAtlasToPdfAlgorithmBase::initAlgorithm();
322 addParameter(
new QgsProcessingParameterExpression( QStringLiteral(
"OUTPUT_FILENAME" ), QObject::tr(
"Output filename" ), QString(), QStringLiteral(
"COVERAGE_LAYER" ),
true ) );
326QgsLayoutAtlasToMultiplePdfAlgorithm *QgsLayoutAtlasToMultiplePdfAlgorithm::createInstance()
const
328 return new QgsLayoutAtlasToMultiplePdfAlgorithm();
338 const QString filename = parameterAsString( parameters, QStringLiteral(
"OUTPUT_FILENAME" ), context );
339 const QString destFolder = parameterAsFile( parameters, QStringLiteral(
"OUTPUT_FOLDER" ), context );
342 const QString dest = QStringLiteral(
"%1/atlas.pdf" ).arg( destFolder );
346 feedback->
pushInfo( QObject::tr(
"Exporting %n atlas feature(s)",
"", atlas->
count() ) );
353 else if ( !filename.isEmpty() )
357 throw QgsProcessingException( QObject::tr(
"Output file name expression is not valid: %1" ).arg( error ) );
367 feedback->
pushInfo( QObject::tr(
"Successfully exported atlas to %1" ).arg( QDir::toNativeSeparators( destFolder ) ) );
372 throw QgsProcessingException( QObject::tr(
"Cannot write to %1.\n\nThis file may be open in another application." ).arg( QDir::toNativeSeparators( dest ) ) );
379 "resulted in a memory overflow.\n\n"
380 "Please try a lower resolution or a smaller paper size." ) );
393 feedback->
reportError( QObject::tr(
"No atlas features found" ) );
399 outputs.insert( QStringLiteral(
"OUTPUT_FOLDER" ), destFolder );
@ 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...
void setProgress(double progress)
Sets the current progress for the feedback object.
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 Flags 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.
@ FlagAdvanced
Parameter is an advanced parameter which should be hidden from users by default.
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.
@ Folder
Parameter is a folder.
A print layout parameter, allowing users to select a print layout.
@ Double
Double/float values.
A vector layer (with or without geometry) parameter for processing algorithms.
@ TypeMapLayer
Any map layer type (raster, vector, mesh, point cloud, annotation or plugin layer)
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....