27 #include <QImageWriter>
31 QString QgsLayoutAtlasToImageAlgorithm::name()
const
33 return QStringLiteral(
"atlaslayouttoimage" );
36 QString QgsLayoutAtlasToImageAlgorithm::displayName()
const
38 return QObject::tr(
"Export atlas layout as image" );
41 QStringList QgsLayoutAtlasToImageAlgorithm::tags()
const
43 return QObject::tr(
"layout,atlas,composer,composition,save,png,jpeg,jpg" ).split(
',' );
46 QString QgsLayoutAtlasToImageAlgorithm::group()
const
48 return QObject::tr(
"Cartography" );
51 QString QgsLayoutAtlasToImageAlgorithm::groupId()
const
53 return QStringLiteral(
"cartography" );
56 QString QgsLayoutAtlasToImageAlgorithm::shortDescription()
const
58 return QObject::tr(
"Exports an atlas layout as a set of images." );
61 QString QgsLayoutAtlasToImageAlgorithm::shortHelpString()
const
63 return QObject::tr(
"This algorithm outputs an atlas layout to a set of image files (e.g. PNG or JPEG images).\n\n"
64 "If a coverage layer is set, the selected layout's atlas settings exposed in this algorithm "
65 "will be overwritten. In this case, an empty filter or sort by expression will turn those "
69 void QgsLayoutAtlasToImageAlgorithm::initAlgorithm(
const QVariantMap & )
74 addParameter(
new QgsProcessingParameterExpression( QStringLiteral(
"FILTER_EXPRESSION" ), QObject::tr(
"Filter expression" ), QString(), QStringLiteral(
"COVERAGE_LAYER" ),
true ) );
75 addParameter(
new QgsProcessingParameterExpression( QStringLiteral(
"SORTBY_EXPRESSION" ), QObject::tr(
"Sort expression" ), QString(), QStringLiteral(
"COVERAGE_LAYER" ),
true ) );
76 addParameter(
new QgsProcessingParameterBoolean( QStringLiteral(
"SORTBY_REVERSE" ), QObject::tr(
"Reverse sort order (used when a sort expression is provided)" ),
false,
true ) );
78 addParameter(
new QgsProcessingParameterExpression( QStringLiteral(
"FILENAME_EXPRESSION" ), QObject::tr(
"Output filename expression" ), QStringLiteral(
"'output_'||@atlas_featurenumber" ), QStringLiteral(
"COVERAGE_LAYER" ) ) );
82 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 );
84 addParameter( layersParam.release() );
86 QStringList imageFormats;
87 const QList<QByteArray> supportedImageFormats { QImageWriter::supportedImageFormats() };
88 for (
const QByteArray &format : supportedImageFormats )
90 if ( format == QByteArray(
"svg" ) )
92 imageFormats << QString( format );
94 std::unique_ptr< QgsProcessingParameterEnum > extensionParam = std::make_unique< QgsProcessingParameterEnum >( QStringLiteral(
"EXTENSION" ), QObject::tr(
"Image format" ), imageFormats,
false, imageFormats.indexOf( QLatin1String(
"png" ) ) );
96 addParameter( extensionParam.release() );
98 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 );
100 addParameter( dpiParam.release() );
102 std::unique_ptr< QgsProcessingParameterBoolean > appendGeorefParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"GEOREFERENCE" ), QObject::tr(
"Generate world file" ),
true );
104 addParameter( appendGeorefParam.release() );
106 std::unique_ptr< QgsProcessingParameterBoolean > exportRDFParam = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"INCLUDE_METADATA" ), QObject::tr(
"Export RDF metadata (title, author, etc.)" ),
true );
108 addParameter( exportRDFParam.release() );
110 std::unique_ptr< QgsProcessingParameterBoolean > antialias = std::make_unique< QgsProcessingParameterBoolean >( QStringLiteral(
"ANTIALIAS" ), QObject::tr(
"Enable antialiasing" ),
true );
112 addParameter( antialias.release() );
115 QgsProcessingAlgorithm::Flags QgsLayoutAtlasToImageAlgorithm::flags()
const
120 QgsLayoutAtlasToImageAlgorithm *QgsLayoutAtlasToImageAlgorithm::createInstance()
const
122 return new QgsLayoutAtlasToImageAlgorithm();
128 QgsPrintLayout *l = parameterAsLayout( parameters, QStringLiteral(
"LAYOUT" ), context );
130 throw QgsProcessingException( QObject::tr(
"Cannot find layout with name \"%1\"" ).arg( parameters.value( QStringLiteral(
"LAYOUT" ) ).toString() ) );
132 std::unique_ptr< QgsPrintLayout > layout( l->
clone() );
135 QString expression, error;
136 QgsVectorLayer *layer = parameterAsVectorLayer( parameters, QStringLiteral(
"COVERAGE_LAYER" ), context );
142 expression = parameterAsString( parameters, QStringLiteral(
"FILTER_EXPRESSION" ), context );
145 if ( !expression.isEmpty() && !error.isEmpty() )
151 expression = parameterAsString( parameters, QStringLiteral(
"SORTBY_EXPRESSION" ), context );
152 if ( !expression.isEmpty() )
154 const bool sortByReverse = parameterAsBool( parameters, QStringLiteral(
"SORTBY_REVERSE" ), context );
169 expression = parameterAsString( parameters, QStringLiteral(
"FILENAME_EXPRESSION" ), context );
171 if ( !error.isEmpty() )
176 const QString directory = parameterAsFileOutput( parameters, QStringLiteral(
"FOLDER" ), context );
177 const QString fileName = QDir( directory ).filePath( QStringLiteral(
"atlas" ) );
179 QStringList imageFormats;
180 const QList<QByteArray> supportedImageFormats { QImageWriter::supportedImageFormats() };
181 for (
const QByteArray &format : supportedImageFormats )
183 if ( format == QByteArray(
"svg" ) )
185 imageFormats << QString( format );
187 const int idx = parameterAsEnum( parameters, QStringLiteral(
"EXTENSION" ), context );
188 const QString extension =
'.' + imageFormats.at( idx );
193 if ( parameters.value( QStringLiteral(
"DPI" ) ).isValid() )
195 settings.
dpi = parameterAsDouble( parameters, QStringLiteral(
"DPI" ), context );
198 settings.
exportMetadata = parameterAsBool( parameters, QStringLiteral(
"INCLUDE_METADATA" ), context );
199 settings.
generateWorldFile = parameterAsBool( parameters, QStringLiteral(
"GEOREFERENCE" ), context );
201 if ( parameterAsBool( parameters, QStringLiteral(
"ANTIALIAS" ), context ) )
208 const QList< QgsMapLayer * > layers = parameterAsLayerList( parameters, QStringLiteral(
"LAYERS" ), context );
209 if ( layers.size() > 0 )
211 const QList<QGraphicsItem *> items = layout->items();
212 for ( QGraphicsItem *graphicsItem : items )
226 feedback->
pushInfo( QObject::tr(
"Exporting %n atlas feature(s)",
"", atlas->
count() ) );
227 switch ( exporter.exportToImage( atlas, fileName, extension, settings, error, feedback ) )
231 feedback->
pushInfo( QObject::tr(
"Successfully exported layout to %1" ).arg( QDir::toNativeSeparators( directory ) ) );
236 throw QgsProcessingException( QObject::tr(
"Cannot write to %1.\n\nThis file may be open in another application." ).arg( QDir::toNativeSeparators( directory ) ) );
240 "resulted in a memory overflow.\n\n"
241 "Please try a lower resolution or a smaller paper size." ) );
255 feedback->
reportError( QObject::tr(
"No atlas features found" ) );
261 outputs.insert( QStringLiteral(
"FOLDER" ), directory );
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 ...
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.
@ 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.
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.
@ FlagAntialiasing
Use antialiasing when drawing items.
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.
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 raster images.
bool generateWorldFile
Set to true to generate an external world file alongside exported images.
bool exportMetadata
Indicates whether image 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.
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.