QGIS API Documentation
3.0.2-Girona (307d082)
|
Class used to render an Atlas, iterating over geometry features. More...
#include <qgslayoutatlas.h>
Public Slots | |
bool | first () |
Seeks to the first feature, returning false if no feature was found. More... | |
bool | last () |
Seeks to the last feature, returning false if no feature was found. More... | |
bool | next () override |
bool | previous () |
Iterates to the previous feature, returning false if no previous feature exists. More... | |
void | refreshCurrentFeature () |
Refreshes the current atlas feature, by refetching its attributes from the vector layer provider. More... | |
bool | seekTo (int feature) |
Seeks to the specified feature number. More... | |
bool | seekTo (const QgsFeature &feature) |
Seeks to the specified feature. More... | |
Signals | |
void | changed () |
Emitted when one of the atlas parameters changes. More... | |
void | coverageLayerChanged (QgsVectorLayer *layer) |
Emitted when the coverage layer for the atlas changes. More... | |
void | featureChanged (const QgsFeature &feature) |
Is emitted when the current atlas feature changes. More... | |
void | messagePushed (const QString &message) |
Is emitted when the atlas has an updated status bar message. More... | |
void | numberFeaturesChanged (int numFeatures) |
Emitted when the number of features for the atlas changes. More... | |
void | renderBegun () |
Emitted when atlas rendering has begun. More... | |
void | renderEnded () |
Emitted when atlas rendering has ended. More... | |
void | toggled (bool) |
Emitted when atlas is enabled or disabled. More... | |
Public Member Functions | |
QgsLayoutAtlas (QgsLayout *layout) | |
Constructor for new QgsLayoutAtlas. More... | |
bool | beginRender () override |
Called when rendering begins, before iteration commences. More... | |
int | count () override |
Returns the number of features to iterate over. More... | |
QgsVectorLayer * | coverageLayer () const |
Returns the coverage layer used for the atlas features. More... | |
int | currentFeatureNumber () const |
Returns the current feature number, where a value of 0 corresponds to the first feature. More... | |
QString | currentFilename () const |
Returns the current feature filename. More... | |
bool | enabled () const |
Returns whether the atlas generation is enabled. More... | |
bool | endRender () override |
Ends the render, performing any required cleanup tasks. More... | |
QString | filenameExpression () const |
Returns the filename expression used for generating output filenames for each atlas page. More... | |
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. More... | |
QString | filterExpression () const |
Returns the expression used for filtering features in the coverage layer. More... | |
bool | filterFeatures () const |
Returns true if features should be filtered in the coverage layer. More... | |
bool | hideCoverage () const |
Returns true if the atlas is set to hide the coverage layer. More... | |
QgsLayout * | layout () override |
Returns the layout associated with the iterator. More... | |
const QgsLayout * | layout () const |
Returns the atlas' layout. More... | |
QString | nameForPage (int page) const |
Returns the calculated name for a specified atlas page number. More... | |
QString | pageNameExpression () const |
Returns the expression (or field name) used for calculating the page name. More... | |
bool | readXml (const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override |
Sets the objects's state from a DOM element. More... | |
void | setCoverageLayer (QgsVectorLayer *layer) |
Sets the coverage layer to use for the atlas features. More... | |
void | setEnabled (bool enabled) |
Sets whether the atlas is enabled. More... | |
bool | setFilenameExpression (const QString &expression, QString &errorString) |
Sets the filename expression used for generating output filenames for each atlas page. More... | |
bool | setFilterExpression (const QString &expression, QString &errorString) |
Sets the expression used for filtering features in the coverage layer. More... | |
void | setFilterFeatures (bool filtered) |
Sets whether features should be filtered in the coverage layer. More... | |
void | setHideCoverage (bool hide) |
Sets whether the coverage layer should be hidden in map items in the layouts. More... | |
void | setPageNameExpression (const QString &expression) |
Sets the expression (or field name) used for calculating the page name. More... | |
void | setSortAscending (bool ascending) |
Sets whether features should be sorted in an ascending order. More... | |
void | setSortExpression (const QString &expression) |
Sets the expression (or field name) to use for sorting features. More... | |
void | setSortFeatures (bool enabled) |
Sets whether features should be sorted in the atlas. More... | |
bool | sortAscending () const |
Returns true if features should be sorted in an ascending order. More... | |
QString | sortExpression () const |
Returns the expression (or field name) to use for sorting features. More... | |
bool | sortFeatures () const |
Returns true if features should be sorted in the atlas. More... | |
QString | stringType () const override |
Return the object type as a string. More... | |
int | updateFeatures () |
Requeries the current atlas coverage layer and applies filtering and sorting. More... | |
bool | writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const override |
Stores the objects's state in a DOM element. More... | |
Public Member Functions inherited from QgsAbstractLayoutIterator | |
virtual | ~QgsAbstractLayoutIterator ()=default |
virtual bool | next ()=0 |
Iterates to next feature, returning false if no more features exist to iterate over. More... | |
Public Member Functions inherited from QgsLayoutSerializableObject | |
QgsAbstractLayoutUndoCommand * | createCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override |
Creates a new layout undo command with the specified text and parent. More... | |
Public Member Functions inherited from QgsLayoutUndoObjectInterface | |
virtual | ~QgsLayoutUndoObjectInterface ()=default |
Destructor for QgsLayoutUndoObjectInterface. More... | |
Friends | |
class | AtlasFeatureSorter |
Class used to render an Atlas, iterating over geometry features.
prepareForFeature() modifies the atlas map's extent to zoom on the given feature. This class is used for printing, exporting to PDF and images.
Definition at line 37 of file qgslayoutatlas.h.
QgsLayoutAtlas::QgsLayoutAtlas | ( | QgsLayout * | layout | ) |
Constructor for new QgsLayoutAtlas.
Definition at line 25 of file qgslayoutatlas.cpp.
|
overridevirtual |
Called when rendering begins, before iteration commences.
Returns true if successful, false if no iteration is available or required.
Implements QgsAbstractLayoutIterator.
Definition at line 314 of file qgslayoutatlas.cpp.
|
signal |
Emitted when one of the atlas parameters changes.
|
overridevirtual |
Returns the number of features to iterate over.
Implements QgsAbstractLayoutIterator.
Definition at line 339 of file qgslayoutatlas.cpp.
|
inline |
Returns the coverage layer used for the atlas features.
Definition at line 112 of file qgslayoutatlas.h.
|
signal |
Emitted when the coverage layer for the atlas changes.
|
inline |
Returns the current feature number, where a value of 0 corresponds to the first feature.
Definition at line 250 of file qgslayoutatlas.h.
QString QgsLayoutAtlas::currentFilename | ( | ) | const |
Returns the current feature filename.
Definition at line 433 of file qgslayoutatlas.cpp.
|
inline |
Returns whether the atlas generation is enabled.
Definition at line 63 of file qgslayoutatlas.h.
|
overridevirtual |
Ends the render, performing any required cleanup tasks.
Implements QgsAbstractLayoutIterator.
Definition at line 332 of file qgslayoutatlas.cpp.
|
signal |
Is emitted when the current atlas feature changes.
|
inline |
Returns the filename expression used for generating output filenames for each atlas page.
Definition at line 89 of file qgslayoutatlas.h.
|
overridevirtual |
Returns the file path for the current feature, based on a specified base file path and extension.
Implements QgsAbstractLayoutIterator.
Definition at line 344 of file qgslayoutatlas.cpp.
|
inline |
Returns the expression used for filtering features in the coverage layer.
This property has no effect is filterFeatures() is false.
Definition at line 221 of file qgslayoutatlas.h.
|
inline |
Returns true if features should be filtered in the coverage layer.
Definition at line 204 of file qgslayoutatlas.h.
|
slot |
Seeks to the first feature, returning false if no feature was found.
Definition at line 377 of file qgslayoutatlas.cpp.
|
inline |
Returns true if the atlas is set to hide the coverage layer.
Definition at line 75 of file qgslayoutatlas.h.
|
slot |
Seeks to the last feature, returning false if no feature was found.
Definition at line 382 of file qgslayoutatlas.cpp.
|
overridevirtual |
Returns the layout associated with the iterator.
Implements QgsAbstractLayoutIterator.
Definition at line 40 of file qgslayoutatlas.cpp.
const QgsLayout * QgsLayoutAtlas::layout | ( | ) | const |
Returns the atlas' layout.
Definition at line 45 of file qgslayoutatlas.cpp.
|
signal |
Is emitted when the atlas has an updated status bar message.
QString QgsLayoutAtlas::nameForPage | ( | int | page | ) | const |
Returns the calculated name for a specified atlas page number.
Page numbers start at 0.
Definition at line 161 of file qgslayoutatlas.cpp.
|
overrideslot |
Definition at line 355 of file qgslayoutatlas.cpp.
|
signal |
Emitted when the number of features for the atlas changes.
|
inline |
Returns the expression (or field name) used for calculating the page name.
Definition at line 125 of file qgslayoutatlas.h.
|
slot |
|
overridevirtual |
Sets the objects's state from a DOM element.
element is the DOM node corresponding to the object.
Implements QgsLayoutSerializableObject.
Definition at line 88 of file qgslayoutatlas.cpp.
|
slot |
Refreshes the current atlas feature, by refetching its attributes from the vector layer provider.
Definition at line 414 of file qgslayoutatlas.cpp.
|
signal |
Emitted when atlas rendering has begun.
|
signal |
Emitted when atlas rendering has ended.
|
slot |
Seeks to the specified feature number.
Definition at line 387 of file qgslayoutatlas.cpp.
|
slot |
Seeks to the specified feature.
Definition at line 392 of file qgslayoutatlas.cpp.
void QgsLayoutAtlas::setCoverageLayer | ( | QgsVectorLayer * | layer | ) |
Sets the coverage layer to use for the atlas features.
Definition at line 150 of file qgslayoutatlas.cpp.
void QgsLayoutAtlas::setEnabled | ( | bool | enabled | ) |
Sets whether the atlas is enabled.
Definition at line 119 of file qgslayoutatlas.cpp.
bool QgsLayoutAtlas::setFilenameExpression | ( | const QString & | expression, |
QString & | errorString | ||
) |
Sets the filename expression used for generating output filenames for each atlas page.
If an invalid expression is passed, false will be returned and errorString will be set to the expression error.
Definition at line 427 of file qgslayoutatlas.cpp.
bool QgsLayoutAtlas::setFilterExpression | ( | const QString & | expression, |
QString & | errorString | ||
) |
Sets the expression used for filtering features in the coverage layer.
This property has no effect is filterFeatures() is false.
If an invalid expression is passed, false will be returned and errorString will be set to the expression error.
Definition at line 169 of file qgslayoutatlas.cpp.
|
inline |
Sets whether features should be filtered in the coverage layer.
Definition at line 211 of file qgslayoutatlas.h.
void QgsLayoutAtlas::setHideCoverage | ( | bool | hide | ) |
Sets whether the coverage layer should be hidden in map items in the layouts.
Definition at line 419 of file qgslayoutatlas.cpp.
|
inline |
Sets the expression (or field name) used for calculating the page name.
Definition at line 131 of file qgslayoutatlas.h.
|
inline |
Sets whether features should be sorted in an ascending order.
This property has no effect is sortFeatures() is false.
Definition at line 175 of file qgslayoutatlas.h.
|
inline |
Sets the expression (or field name) to use for sorting features.
This property has no effect is sortFeatures() is false.
Definition at line 197 of file qgslayoutatlas.h.
|
inline |
Sets whether features should be sorted in the atlas.
Definition at line 153 of file qgslayoutatlas.h.
|
inline |
Returns true if features should be sorted in an ascending order.
This property has no effect is sortFeatures() is false.
Definition at line 164 of file qgslayoutatlas.h.
|
inline |
Returns the expression (or field name) to use for sorting features.
This property has no effect is sortFeatures() is false.
Definition at line 186 of file qgslayoutatlas.h.
|
inline |
Returns true if features should be sorted in the atlas.
Definition at line 145 of file qgslayoutatlas.h.
|
overridevirtual |
Return the object type as a string.
This string must be a unique, single word, character only representation of the item type, eg "LayoutScaleBar"
Implements QgsLayoutSerializableObject.
Definition at line 35 of file qgslayoutatlas.cpp.
|
signal |
Emitted when atlas is enabled or disabled.
int QgsLayoutAtlas::updateFeatures | ( | ) |
Requeries the current atlas coverage layer and applies filtering and sorting.
Returns number of matching features.
Definition at line 207 of file qgslayoutatlas.cpp.
|
overridevirtual |
Stores the objects's state in a DOM element.
The parentElement should refer to the parent layout's DOM element.
Implements QgsLayoutSerializableObject.
Definition at line 50 of file qgslayoutatlas.cpp.
|
friend |
Definition at line 392 of file qgslayoutatlas.h.