19#include <QtAlgorithms>
33 , mFilenameExpressionString( QStringLiteral(
"'output_'||@atlas_featurenumber" ) )
40 mLayout->setCustomProperty( QStringLiteral(
"singleFile" ),
true );
45 return QStringLiteral(
"atlas" );
55 return mLayout.data();
60 QDomElement atlasElem = document.createElement( QStringLiteral(
"Atlas" ) );
61 atlasElem.setAttribute( QStringLiteral(
"enabled" ), mEnabled ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
65 atlasElem.setAttribute( QStringLiteral(
"coverageLayer" ), mCoverageLayer.
layerId );
66 atlasElem.setAttribute( QStringLiteral(
"coverageLayerName" ), mCoverageLayer.
name );
67 atlasElem.setAttribute( QStringLiteral(
"coverageLayerSource" ), mCoverageLayer.
source );
68 atlasElem.setAttribute( QStringLiteral(
"coverageLayerProvider" ), mCoverageLayer.
provider );
72 atlasElem.setAttribute( QStringLiteral(
"coverageLayer" ), QString() );
75 atlasElem.setAttribute( QStringLiteral(
"hideCoverage" ), mHideCoverage ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
76 atlasElem.setAttribute( QStringLiteral(
"filenamePattern" ), mFilenameExpressionString );
77 atlasElem.setAttribute( QStringLiteral(
"pageNameExpression" ), mPageNameExpression );
79 atlasElem.setAttribute( QStringLiteral(
"sortFeatures" ), mSortFeatures ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
82 atlasElem.setAttribute( QStringLiteral(
"sortKey" ), mSortExpression );
83 atlasElem.setAttribute( QStringLiteral(
"sortAscending" ), mSortAscending ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
85 atlasElem.setAttribute( QStringLiteral(
"filterFeatures" ), mFilterFeatures ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
86 if ( mFilterFeatures )
88 atlasElem.setAttribute( QStringLiteral(
"featureFilter" ), mFilterExpression );
91 parentElement.appendChild( atlasElem );
98 mEnabled = atlasElem.attribute( QStringLiteral(
"enabled" ), QStringLiteral(
"0" ) ).toInt();
101 const QString layerId = atlasElem.attribute( QStringLiteral(
"coverageLayer" ) );
102 const QString layerName = atlasElem.attribute( QStringLiteral(
"coverageLayerName" ) );
103 const QString layerSource = atlasElem.attribute( QStringLiteral(
"coverageLayerSource" ) );
104 const QString layerProvider = atlasElem.attribute( QStringLiteral(
"coverageLayerProvider" ) );
106 mCoverageLayer =
QgsVectorLayerRef( layerId, layerName, layerSource, layerProvider );
108 mLayout->reportContext().setLayer( mCoverageLayer.
get() );
110 mPageNameExpression = atlasElem.attribute( QStringLiteral(
"pageNameExpression" ), QString() );
112 setFilenameExpression( atlasElem.attribute( QStringLiteral(
"filenamePattern" ), QString() ), error );
114 mSortFeatures = atlasElem.attribute( QStringLiteral(
"sortFeatures" ), QStringLiteral(
"0" ) ).toInt();
115 mSortExpression = atlasElem.attribute( QStringLiteral(
"sortKey" ) );
116 mSortAscending = atlasElem.attribute( QStringLiteral(
"sortAscending" ), QStringLiteral(
"1" ) ).toInt();
117 mFilterFeatures = atlasElem.attribute( QStringLiteral(
"filterFeatures" ), QStringLiteral(
"0" ) ).toInt();
118 mFilterExpression = atlasElem.attribute( QStringLiteral(
"featureFilter" ) );
120 mHideCoverage = atlasElem.attribute( QStringLiteral(
"hideCoverage" ), QStringLiteral(
"0" ) ).toInt();
139void QgsLayoutAtlas::removeLayers(
const QStringList &layers )
141 if ( !mCoverageLayer )
146 for (
const QString &layerId : layers )
148 if ( layerId == mCoverageLayer.
layerId )
160 if ( layer == mCoverageLayer.
get() )
171 if ( mPageNameExpression == expression )
174 mPageNameExpression = expression;
180 if ( pageNumber < 0 || pageNumber >= mFeatureIds.count() )
183 return mFeatureIds.at( pageNumber ).second;
188 if ( mSortFeatures ==
enabled )
197 if ( mSortAscending == ascending )
200 mSortAscending = ascending;
206 if ( mSortExpression == expression )
209 mSortExpression = expression;
215 if ( mFilterFeatures == filtered )
218 mFilterFeatures = filtered;
225 const bool hasChanged = mFilterExpression != expression;
226 mFilterExpression = expression;
242class AtlasFeatureSorter
245 AtlasFeatureSorter( QgsLayoutAtlas::SorterKeys &keys,
bool ascending =
true )
247 , mAscending( ascending )
250 bool operator()(
const QPair< QgsFeatureId, QString > &id1,
const QPair< QgsFeatureId, QString > &id2 )
252 return mAscending ?
qgsVariantLessThan( mKeys.value( id1.first ), mKeys.value( id2.first ) )
257 QgsLayoutAtlas::SorterKeys &mKeys;
265 mCurrentFeatureNo = -1;
266 if ( !mCoverageLayer )
274 updateFilenameExpression( error );
281 mFilterParserError.clear();
282 if ( mFilterFeatures && !mFilterExpression.isEmpty() )
295#ifdef HAVE_SERVER_PYTHON_PLUGINS
296 if ( mLayout->renderContext().featureFilterProvider() )
298 mLayout->renderContext().featureFilterProvider()->filterFeatures( mCoverageLayer.
get(), req );
304 std::unique_ptr<QgsExpression> nameExpression;
305 if ( !mPageNameExpression.isEmpty() )
307 nameExpression = std::make_unique< QgsExpression >( mPageNameExpression );
308 if ( nameExpression->hasParserError() )
310 nameExpression.reset(
nullptr );
314 nameExpression->prepare( &expressionContext );
322 mFeatureKeys.clear();
325 if ( mSortFeatures && !mSortExpression.isEmpty() )
327 sortExpression = std::make_unique< QgsExpression >( mSortExpression );
343 if ( nameExpression )
345 const QVariant result = nameExpression->evaluate( &expressionContext );
346 if ( nameExpression->hasEvalError() )
350 pageName = result.toString();
353 mFeatureIds.push_back( qMakePair( feat.
id(), pageName ) );
357 const QVariant result =
sortExpression->evaluate( &expressionContext );
362 mFeatureKeys.insert( feat.
id(), result );
367 if ( !mFeatureKeys.isEmpty() )
370 std::sort( mFeatureIds.begin(), mFeatureIds.end(), sorter );
374 return mFeatureIds.size();
379 if ( !mCoverageLayer )
404 return mFeatureIds.size();
409 const QFileInfo fi( baseFilePath );
410 const QDir dir = fi.dir();
411 QString base = dir.filePath( mCurrentFilename );
412 if ( !extension.startsWith(
'.' ) )
420 const int newFeatureNo = mCurrentFeatureNo + 1;
421 if ( newFeatureNo >= mFeatureIds.size() )
426 return prepareForFeature( newFeatureNo );
431 const int newFeatureNo = mCurrentFeatureNo - 1;
432 if ( newFeatureNo < 0 )
437 return prepareForFeature( newFeatureNo );
442 return prepareForFeature( 0 );
447 return prepareForFeature( mFeatureIds.size() - 1 );
452 return prepareForFeature( feature );
458 auto it = mFeatureIds.constBegin();
459 for (
int currentIdx = 0; it != mFeatureIds.constEnd(); ++it, ++currentIdx )
461 if ( ( *it ).first == feature.
id() )
479 prepareForFeature( mCurrentFeatureNo );
485 if ( hide == mHideCoverage )
488 mHideCoverage = hide;
495 const bool hasChanged = mFilenameExpressionString != pattern;
496 mFilenameExpressionString = pattern;
501 return updateFilenameExpression( errorString );
506 return mCurrentFilename;
519 if ( mCoverageLayer )
522 if ( mLayout && mEnabled )
524 if ( mCurrentFeature.
isValid() )
528 else if ( mCoverageLayer )
531 feature.setValid(
true );
535 return expressionContext;
538bool QgsLayoutAtlas::updateFilenameExpression( QString &error )
540 if ( !mCoverageLayer )
546 bool evalResult {
true };
548 if ( !mFilenameExpressionString.isEmpty() )
566 evalResult = evalFeatureFilename( expressionContext );
571 error = mFilenameExpressionError;
580 mFilenameExpressionError.clear();
581 if ( !mFilenameExpressionString.isEmpty() )
593 mCurrentFilename = filenameRes.toString();
598bool QgsLayoutAtlas::prepareForFeature(
const int featureI )
600 if ( !mCoverageLayer )
605 if ( mFeatureIds.isEmpty() )
611 if ( featureI >= mFeatureIds.size() )
616 mCurrentFeatureNo = featureI;
622 mLayout->reportContext().blockSignals(
true );
623 mLayout->reportContext().setLayer( mCoverageLayer.
get() );
624 mLayout->reportContext().blockSignals(
false );
625 mLayout->reportContext().setFeature( mCurrentFeature );
631 if ( !evalFeatureFilename( expressionContext ) )
638 emit
messagePushed( tr(
"Atlas feature %1 of %2" ).arg( featureI + 1 ).arg( mFeatureIds.size() ) );
640 return mCurrentFeature.
isValid();
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the scope.
static QgsExpressionContextScope * layoutScope(const QgsLayout *layout)
Creates a new scope which contains variables and functions relating to a QgsLayout layout.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * atlasScope(const QgsLayoutAtlas *atlas)
Creates a new scope which contains variables and functions relating to a QgsLayoutAtlas.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QgsExpressionContextScope * lastScope()
Returns the last scope added to the context.
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
Class for parsing and evaluation of expressions (formerly called "search strings").
Wrapper for iterator of features from vector data provider or vector layer.
bool nextFeature(QgsFeature &f)
This class wraps a request for features to a vector layer (or directly its vector data provider).
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
QgsFeatureRequest & setExpressionContext(const QgsExpressionContext &context)
Sets the expression context used to evaluate filter expressions.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
bool isValid() const
Returns the validity of this feature.
QString nameForPage(int page) const
Returns the calculated name for a specified atlas page number.
QString sortExpression() const
Returns the expression (or field name) to use for sorting features.
bool writeXml(QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const override
Stores the objects's state in a DOM element.
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 beginRender() override
Called when rendering begins, before iteration commences.
bool setFilterExpression(const QString &expression, QString &errorString)
Sets the expression used for filtering features in the coverage layer.
void toggled(bool)
Emitted when atlas is enabled or disabled.
void setSortAscending(bool ascending)
Sets whether features should be sorted in an ascending order.
bool seekTo(int feature)
Seeks to the specified feature number.
void featureChanged(const QgsFeature &feature)
Emitted when the current atlas feature changes.
void setEnabled(bool enabled)
Sets whether the atlas is enabled.
friend class AtlasFeatureSorter
void setPageNameExpression(const QString &expression)
Sets the expression (or field name) used for calculating the page name.
bool first()
Seeks to the first feature, returning false if no feature was found.
QString filterExpression() const
Returns the expression used for filtering features in the coverage layer.
QgsLayout * layout() override
Returns the layout associated with the iterator.
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.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
void setSortFeatures(bool enabled)
Sets whether features should be sorted in the atlas.
QString filePath(const QString &baseFilePath, const QString &extension) override
Returns the file path for the current feature, based on a specified base file path and extension.
QString currentFilename() const
Returns the current feature filename.
bool readXml(const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
Sets the objects's state from a DOM element.
bool last()
Seeks to the last feature, returning false if no feature was found.
QgsLayoutAtlas(QgsLayout *layout)
Constructor for new QgsLayoutAtlas.
int count() const override
Returns the number of features to iterate over.
void numberFeaturesChanged(int numFeatures)
Emitted when the number of features for the atlas changes.
void messagePushed(const QString &message)
Emitted when the atlas has an updated status bar message.
void setSortExpression(const QString &expression)
Sets the expression (or field name) to use for sorting features.
void coverageLayerChanged(QgsVectorLayer *layer)
Emitted when the coverage layer for the atlas changes.
void setFilterFeatures(bool filtered)
Sets whether features should be filtered in the coverage layer.
void renderBegun()
Emitted when atlas rendering has begun.
void renderEnded()
Emitted when atlas rendering has ended.
void changed()
Emitted when one of the atlas parameters changes.
bool previous()
Iterates to the previous feature, returning false if no previous feature exists.
void refreshCurrentFeature()
Refreshes the current atlas feature, by refetching its attributes from the vector layer provider.
bool endRender() override
Ends the render, performing any required cleanup tasks.
int updateFeatures()
Requeries the current atlas coverage layer and applies filtering and sorting.
QString stringType() const override
Returns the object type as a string.
void setHideCoverage(bool hide)
Sets whether the coverage layer should be hidden in map items in the layouts.
@ FlagHideCoverageLayer
Hide coverage layer in outputs.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
void layersWillBeRemoved(const QStringList &layerIds)
Emitted when one or more layers are about to be removed from the registry.
The class is used as a container of context for various read/write operations on other objects.
static bool isNull(const QVariant &variant)
Returns true if the specified variant should be considered a NULL value.
Represents a vector layer which manages a vector based data sets.
QgsExpressionContextScope * createExpressionContextScope() const FINAL
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const FINAL
Queries the layer for features specified in request.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
bool qgsVariantLessThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is less than the second.
bool qgsVariantGreaterThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is greater than the second.
_LayerRef< QgsVectorLayer > QgsVectorLayerRef
TYPE * resolveWeakly(const QgsProject *project, MatchType matchType=MatchType::All)
Resolves the map layer by attempting to find a matching layer in a project using a weak match.
QString source
Weak reference to layer public source.
QString name
Weak reference to layer name.
TYPE * get() const
Returns a pointer to the layer, or nullptr if the reference has not yet been matched to a layer.
QString provider
Weak reference to layer provider.
void setLayer(TYPE *l)
Sets the reference to point to a specified layer.
QString layerId
Original layer ID.