19 #include <QtAlgorithms> 28 , mFilenameExpressionString( QStringLiteral(
"'output_'||@atlas_featurenumber" ) )
37 return QStringLiteral(
"atlas" );
47 return mLayout.data();
52 QDomElement atlasElem = document.createElement( QStringLiteral(
"Atlas" ) );
53 atlasElem.setAttribute( QStringLiteral(
"enabled" ), mEnabled ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
57 atlasElem.setAttribute( QStringLiteral(
"coverageLayer" ), mCoverageLayer.
layerId );
58 atlasElem.setAttribute( QStringLiteral(
"coverageLayerName" ), mCoverageLayer.
name );
59 atlasElem.setAttribute( QStringLiteral(
"coverageLayerSource" ), mCoverageLayer.
source );
60 atlasElem.setAttribute( QStringLiteral(
"coverageLayerProvider" ), mCoverageLayer.
provider );
64 atlasElem.setAttribute( QStringLiteral(
"coverageLayer" ), QString() );
67 atlasElem.setAttribute( QStringLiteral(
"hideCoverage" ), mHideCoverage ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
68 atlasElem.setAttribute( QStringLiteral(
"filenamePattern" ), mFilenameExpressionString );
69 atlasElem.setAttribute( QStringLiteral(
"pageNameExpression" ), mPageNameExpression );
71 atlasElem.setAttribute( QStringLiteral(
"sortFeatures" ), mSortFeatures ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
74 atlasElem.setAttribute( QStringLiteral(
"sortKey" ), mSortExpression );
75 atlasElem.setAttribute( QStringLiteral(
"sortAscending" ), mSortAscending ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
77 atlasElem.setAttribute( QStringLiteral(
"filterFeatures" ), mFilterFeatures ? QStringLiteral(
"1" ) : QStringLiteral(
"0" ) );
78 if ( mFilterFeatures )
80 atlasElem.setAttribute( QStringLiteral(
"featureFilter" ), mFilterExpression );
83 parentElement.appendChild( atlasElem );
90 mEnabled = atlasElem.attribute( QStringLiteral(
"enabled" ), QStringLiteral(
"0" ) ).toInt();
93 QString layerId = atlasElem.attribute( QStringLiteral(
"coverageLayer" ) );
94 QString layerName = atlasElem.attribute( QStringLiteral(
"coverageLayerName" ) );
95 QString layerSource = atlasElem.attribute( QStringLiteral(
"coverageLayerSource" ) );
96 QString layerProvider = atlasElem.attribute( QStringLiteral(
"coverageLayerProvider" ) );
98 mCoverageLayer =
QgsVectorLayerRef( layerId, layerName, layerSource, layerProvider );
100 mLayout->reportContext().setLayer( mCoverageLayer.
get() );
102 mPageNameExpression = atlasElem.attribute( QStringLiteral(
"pageNameExpression" ), QString() );
104 setFilenameExpression( atlasElem.attribute( QStringLiteral(
"filenamePattern" ), QString() ), error );
106 mSortFeatures = atlasElem.attribute( QStringLiteral(
"sortFeatures" ), QStringLiteral(
"0" ) ).toInt();
107 mSortExpression = atlasElem.attribute( QStringLiteral(
"sortKey" ) );
108 mSortAscending = atlasElem.attribute( QStringLiteral(
"sortAscending" ), QStringLiteral(
"1" ) ).toInt();
109 mFilterFeatures = atlasElem.attribute( QStringLiteral(
"filterFeatures" ), QStringLiteral(
"0" ) ).toInt();
110 mFilterExpression = atlasElem.attribute( QStringLiteral(
"featureFilter" ) );
112 mHideCoverage = atlasElem.attribute( QStringLiteral(
"hideCoverage" ), QStringLiteral(
"0" ) ).toInt();
121 if ( enabled == mEnabled )
131 void QgsLayoutAtlas::removeLayers(
const QStringList &layers )
133 if ( !mCoverageLayer )
138 for (
const QString &layerId : layers )
140 if ( layerId == mCoverageLayer.
layerId )
152 if ( layer == mCoverageLayer.
get() )
163 if ( pageNumber < 0 || pageNumber >= mFeatureIds.count() )
166 return mFeatureIds.at( pageNumber ).second;
172 mFilterExpression = expression;
175 if ( filterExpression.hasParserError() )
177 errorString = filterExpression.parserErrorString();
191 , mAscending( ascending )
194 bool operator()(
const QPair< QgsFeatureId, QString > &id1,
const QPair< QgsFeatureId, QString > &id2 )
196 return mAscending ?
qgsVariantLessThan( mKeys.value( id1.first ), mKeys.value( id2.first ) )
201 QgsLayoutAtlas::SorterKeys &mKeys;
209 mCurrentFeatureNo = -1;
210 if ( !mCoverageLayer )
218 updateFilenameExpression( error );
225 mFilterParserError.clear();
226 if ( mFilterFeatures && !mFilterExpression.isEmpty() )
229 if ( filterExpression.hasParserError() )
231 mFilterParserError = filterExpression.parserErrorString();
241 std::unique_ptr<QgsExpression> nameExpression;
242 if ( !mPageNameExpression.isEmpty() )
244 nameExpression = qgis::make_unique< QgsExpression >( mPageNameExpression );
245 if ( nameExpression->hasParserError() )
247 nameExpression.reset(
nullptr );
251 nameExpression->prepare( &expressionContext );
259 mFeatureKeys.clear();
262 if ( mSortFeatures && !mSortExpression.isEmpty() )
264 sortExpression = qgis::make_unique< QgsExpression >( mSortExpression );
265 if ( sortExpression->hasParserError() )
267 sortExpression.reset(
nullptr );
271 sortExpression->prepare( &expressionContext );
280 if ( nameExpression )
282 QVariant result = nameExpression->evaluate( &expressionContext );
283 if ( nameExpression->hasEvalError() )
287 pageName = result.toString();
290 mFeatureIds.push_back( qMakePair( feat.
id(), pageName ) );
292 if ( sortExpression )
294 QVariant result = sortExpression->evaluate( &expressionContext );
295 if ( sortExpression->hasEvalError() )
299 mFeatureKeys.insert( feat.
id(), result );
304 if ( !mFeatureKeys.isEmpty() )
307 std::sort( mFeatureIds.begin(), mFeatureIds.end(), sorter );
311 return mFeatureIds.size();
316 if ( !mCoverageLayer )
341 return mFeatureIds.size();
346 QFileInfo fi( baseFilePath );
348 QString base = dir.filePath( mCurrentFilename );
349 if ( !extension.startsWith(
'.' ) )
357 int newFeatureNo = mCurrentFeatureNo + 1;
358 if ( newFeatureNo >= mFeatureIds.size() )
363 return prepareForFeature( newFeatureNo );
368 int newFeatureNo = mCurrentFeatureNo - 1;
369 if ( newFeatureNo < 0 )
374 return prepareForFeature( newFeatureNo );
379 return prepareForFeature( 0 );
384 return prepareForFeature( mFeatureIds.size() - 1 );
389 return prepareForFeature( feature );
395 auto it = mFeatureIds.constBegin();
396 for (
int currentIdx = 0; it != mFeatureIds.constEnd(); ++it, ++currentIdx )
398 if ( ( *it ).first == feature.
id() )
416 prepareForFeature( mCurrentFeatureNo );
421 mHideCoverage = hide;
429 mFilenameExpressionString = pattern;
430 return updateFilenameExpression( errorString );
435 return mCurrentFilename;
448 if ( mCoverageLayer )
451 if ( mLayout && mEnabled )
454 return expressionContext;
457 bool QgsLayoutAtlas::updateFilenameExpression( QString &error )
459 if ( !mCoverageLayer )
466 if ( !mFilenameExpressionString.isEmpty() )
468 mFilenameExpression = QgsExpression( mFilenameExpressionString );
471 if ( mFilenameExpression.hasParserError() )
473 error = mFilenameExpression.parserErrorString();
478 mFilenameExpression.prepare( &expressionContext );
482 evalFeatureFilename( expressionContext );
489 if ( !mFilenameExpressionString.isEmpty() && mFilenameExpression.isValid() )
491 QVariant filenameRes = mFilenameExpression.evaluate( &context );
492 if ( mFilenameExpression.hasEvalError() )
494 QgsMessageLog::logMessage( tr(
"Atlas filename evaluation error: %1" ).arg( mFilenameExpression.evalErrorString() ), tr(
"Layout" ) );
498 mCurrentFilename = filenameRes.toString();
503 bool QgsLayoutAtlas::prepareForFeature(
const int featureI )
505 if ( !mCoverageLayer )
510 if ( mFeatureIds.isEmpty() )
516 if ( featureI >= mFeatureIds.size() )
521 mCurrentFeatureNo = featureI;
524 if ( !mCoverageLayer->getFeatures(
QgsFeatureRequest().setFilterFid( mFeatureIds[ featureI ].
first ) ).nextFeature( mCurrentFeature ) )
530 if ( !evalFeatureFilename( expressionContext ) )
536 mLayout->reportContext().blockSignals(
true );
537 mLayout->reportContext().setLayer( mCoverageLayer.get() );
538 mLayout->reportContext().blockSignals(
false );
539 mLayout->reportContext().setFeature( mCurrentFeature );
542 emit
messagePushed( QString( tr(
"Atlas feature %1 of %2" ) ).arg( featureI + 1 ).arg( mFeatureIds.size() ) );
544 return mCurrentFeature.isValid();
void setCoverageLayer(QgsVectorLayer *layer)
Sets the coverage layer to use for the atlas features.
The class is used as a container of context for various read/write operations on other objects...
Wrapper for iterator of features from vector data provider or vector layer.
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...
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the context.
QString sortExpression() const
Returns the expression (or field name) to use for sorting features.
TYPE * resolveWeakly(const QgsProject *project)
Resolves the map layer by attempting to find a matching layer in a project using a weak match...
QString stringType() const override
Return the object type as a string.
void setFields(const QgsFields &fields)
Convenience function for setting a fields for the scope.
void toggled(bool)
Emitted when atlas is enabled or disabled.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
bool qgsVariantGreaterThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is greater than the second.
bool writeXml(QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const override
Stores the objects's state in a DOM element.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::Warning)
add a message to the instance (and create it if necessary)
bool qgsVariantLessThan(const QVariant &lhs, const QVariant &rhs)
Compares two QVariant values and returns whether the first is less than the second.
QgsLayoutAtlas(QgsLayout *layout)
Constructor for new QgsLayoutAtlas.
QgsLayout * layout() override
Returns the layout associated with the iterator.
bool endRender() override
Ends the render, performing any required cleanup tasks.
bool setFilenameExpression(const QString &expression, QString &errorString)
Sets the filename expression used for generating output filenames for each atlas page.
QgsFeatureRequest & setExpressionContext(const QgsExpressionContext &context)
Sets the expression context used to evaluate filter expressions.
void refreshCurrentFeature()
Refreshes the current atlas feature, by refetching its attributes from the vector layer provider...
void numberFeaturesChanged(int numFeatures)
Emitted when the number of features for the atlas changes.
QgsExpressionContextScope * lastScope()
Returns the last scope added to the context.
QgsFeatureRequest & setFilterExpression(const QString &expression)
Set the filter expression.
QString provider
Weak reference to layer provider.
QString layerId
Original layer ID.
static QgsExpressionContextScope * globalScope()
Creates a new scope which contains variables and functions relating to the global QGIS context...
bool readXml(const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
Sets the objects's state from a DOM element.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
QString name
Weak reference to layer name.
bool last()
Seeks to the last feature, returning false if no feature was found.
This class wraps a request for features to a vector layer (or directly its vector data provider)...
Hide coverage layer in outputs.
Reads and writes project states.
QString currentFilename() const
Returns the current feature filename.
void setHideCoverage(bool hide)
Sets whether the coverage layer should be hidden in map items in the layouts.
int count() override
Returns the number of features to iterate over.
bool first()
Seeks to the first feature, returning false if no feature was found.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the scope.
void setLayer(TYPE *l)
Sets the reference to point to a specified layer.
void renderBegun()
Emitted when atlas rendering has begun.
QString source
Weak reference to layer public source.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
bool previous()
Iterates to the previous feature, returning false if no previous feature exists.
QString filterExpression() const
Returns the expression used for filtering features in the coverage layer.
bool setFilterExpression(const QString &expression, QString &errorString)
Sets the expression used for filtering features in the coverage layer.
void renderEnded()
Emitted when atlas rendering has ended.
static QgsExpressionContextScope * atlasScope(QgsLayoutAtlas *atlas)
Creates a new scope which contains variables and functions relating to a QgsLayoutAtlas.
void layersWillBeRemoved(const QStringList &layerIds)
Emitted when one or more layers are about to be removed from the registry.
static QgsExpressionContextScope * layoutScope(const QgsLayout *layout)
Creates a new scope which contains variables and functions relating to a QgsLayout layout...
void setEnabled(bool enabled)
Sets whether the atlas is enabled.
friend class AtlasFeatureSorter
void appendScope(QgsExpressionContextScope *scope)
Appends a scope to the end of the context.
void featureChanged(const QgsFeature &feature)
Is emitted when the current atlas feature changes.
_LayerRef< QgsVectorLayer > QgsVectorLayerRef
int updateFeatures()
Requeries the current atlas coverage layer and applies filtering and sorting.
QString nameForPage(int page) const
Returns the calculated name for a specified atlas page number.
bool enabled() const
Returns whether the atlas generation is enabled.
bool beginRender() override
Called when rendering begins, before iteration commences.
void messagePushed(const QString &message)
Is emitted when the atlas has an updated status bar message.
bool nextFeature(QgsFeature &f)
Represents a vector layer which manages a vector based data sets.
TYPE * get() const
Returns a pointer to the layer, or nullptr if the reference has not yet been matched to a layer...
void changed()
Emitted when one of the atlas parameters changes.
bool seekTo(int feature)
Seeks to the specified feature number.
void coverageLayerChanged(QgsVectorLayer *layer)
Emitted when the coverage layer for the atlas changes.