51 for ( QVariantMap::const_iterator it = customVariables.constBegin(); it != customVariables.constEnd(); ++it )
83 if ( vars.remove( name ) )
102 const QString
id = values.at( 0 ).toString();
110 return c.variablesToMap();
115 return new GetLayoutItemVariables( mLayout );
128 GetLayoutMapLayerCredits(
const QgsLayout *
c )
132 <<
QgsExpressionFunction::Parameter( QStringLiteral(
"layer_name_separator" ), true, QStringLiteral(
": " ) ), QStringLiteral(
"Layout" ) )
141 const QString
id = values.value( 0 ).toString();
142 const bool includeLayerNames = values.value( 1 ).toBool();
143 const QString layerNameSeparator = values.value( 2 ).toString();
145 QList< QgsLayoutItemMap * > maps;
146 mLayout->layoutItems( maps );
149 QList< const QgsMapLayer * > layers;
150 bool foundMap =
false;
153 if ( !
id.isEmpty() && map->id() !=
id )
159 const QVariantList mapLayers =
c.variable( QStringLiteral(
"map_layers" ) ).toList();
162 for (
const QVariant &value : mapLayers )
164 if (
const QgsMapLayer *layer = qobject_cast< const QgsMapLayer * >( value.value< QObject * >() ) )
166 if ( !layers.contains( layer ) )
175 res.reserve( layers.size() );
176 for (
const QgsMapLayer *layer : std::as_const( layers ) )
178 const QStringList credits = !layer->metadata().rights().isEmpty() ? layer->metadata().rights() : QStringList() << layer->attribution();
179 for (
const QString &credit : credits )
181 if ( credit.trimmed().isEmpty() )
184 const QString creditString = includeLayerNames ? layer->name() + layerNameSeparator + credit
187 if ( !res.contains( creditString ) )
197 return new GetLayoutMapLayerCredits( mLayout );
209 GetCurrentFormFieldValue( )
215 const QString fieldName( values.at( 0 ).toString() );
216 const QgsFeature feat( context->
variable( QStringLiteral(
"current_feature" ) ).value<QgsFeature>() );
217 if ( fieldName.isEmpty() || ! feat.isValid( ) )
221 return feat.attribute( fieldName ) ;
226 return new GetCurrentFormFieldValue( );
239 GetCurrentParentFormFieldValue( )
245 const QString fieldName( values.at( 0 ).toString() );
246 const QgsFeature feat( context->
variable( QStringLiteral(
"current_parent_feature" ) ).value<QgsFeature>() );
247 if ( fieldName.isEmpty() || ! feat.isValid( ) )
251 return feat.attribute( fieldName ) ;
256 return new GetCurrentParentFormFieldValue( );
270 GetProcessingParameterValue(
const QVariantMap ¶ms )
277 return mParams.value( values.at( 0 ).toString() );
282 return new GetProcessingParameterValue( mParams );
287 const QVariantMap mParams;
297 scope->
addFunction( QStringLiteral(
"current_value" ),
new GetCurrentFormFieldValue( ) );
299 scope->
setVariable( QStringLiteral(
"current_feature" ), formFeature,
true );
300 scope->
setVariable( QStringLiteral(
"form_mode" ), formMode,
true );
308 scope->
addFunction( QStringLiteral(
"current_parent_value" ),
new GetCurrentParentFormFieldValue( ) );
309 scope->
setVariable( QStringLiteral(
"current_parent_geometry" ), parentFormFeature.
geometry( ),
true );
310 scope->
setVariable( QStringLiteral(
"current_parent_feature" ), parentFormFeature,
true );
311 scope->
setVariable( QStringLiteral(
"parent_form_mode" ), parentFormMode,
true );
333 vars.insert( name, value );
354 if ( vars.remove( name ) )
366 const QStringList variableNames = layer->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
367 const QStringList variableValues = layer->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
370 for (
const QString &variableName : variableNames )
372 if ( varIndex >= variableValues.length() )
377 const QVariant varValue = variableValues.at( varIndex );
379 scope->
setVariable( variableName, varValue,
true );
388 const QgsVectorLayer *vLayer = qobject_cast< const QgsVectorLayer * >( layer );
403 QList<QgsExpressionContextScope *> scopes;
422 QStringList variableNames = layer->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
423 QStringList variableValues = layer->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
425 variableNames << name;
426 variableValues << value.toString();
437 QStringList variableNames;
438 QStringList variableValues;
440 QVariantMap::const_iterator it = variables.constBegin();
441 for ( ; it != variables.constEnd(); ++it )
443 variableNames << it.key();
444 variableValues << it.value().toString();
498 QVariantList layersIds;
500 const QList<QgsMapLayer *> layersInMap = mapSettings.
layers(
true );
501 layersIds.reserve( layersInMap.count() );
502 layers.reserve( layersInMap.count() );
505 layersIds << layer->id();
518 scope->
addFunction( QStringLiteral(
"is_layer_visible" ),
new GetLayerVisibility( mapSettings.
layers(
true ), mapSettings.
scale() ) );
542 QVariantList matchList;
546 QVariantMap matchMap;
548 matchMap.insert( QStringLiteral(
"valid" ), match.isValid() );
549 matchMap.insert( QStringLiteral(
"layer" ), QVariant::fromValue<QgsWeakMapLayerPointer>(
QgsWeakMapLayerPointer( match.layer() ) ) );
550 matchMap.insert( QStringLiteral(
"feature_id" ), match.featureId() );
551 matchMap.insert( QStringLiteral(
"vertex_index" ), match.vertexIndex() );
552 matchMap.insert( QStringLiteral(
"distance" ), match.distance() );
554 matchList.append( matchMap );
591 return scope.release();
594 const QStringList variableNames = layout->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
595 const QStringList variableValues = layout->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
599 for (
const QString &variableName : variableNames )
601 if ( varIndex >= variableValues.length() )
606 const QVariant varValue = variableValues.at( varIndex );
608 scope->setVariable( variableName, varValue );
624 QVariantList offsets;
634 scope->addFunction( QStringLiteral(
"item_variables" ),
new GetLayoutItemVariables( layout ) );
635 scope->addFunction( QStringLiteral(
"map_credits" ),
new GetLayoutMapLayerCredits( layout ) );
647 scope->setFeature( atlasFeature );
653 return scope.release();
662 QStringList variableNames = layout->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
663 QStringList variableValues = layout->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
665 variableNames << name;
666 variableValues << value.toString();
677 QStringList variableNames;
678 QStringList variableValues;
680 QVariantMap::const_iterator it = variables.constBegin();
681 for ( ; it != variables.constEnd(); ++it )
683 variableNames << it.key();
684 variableValues << it.value().toString();
737 const QStringList variableNames = item->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
738 const QStringList variableValues = item->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
741 for (
const QString &variableName : variableNames )
743 if ( varIndex >= variableValues.length() )
748 const QVariant varValue = variableValues.at( varIndex );
783 QStringList variableNames = item->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
784 QStringList variableValues = item->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
786 variableNames << name;
787 variableValues << value.toString();
798 QStringList variableNames;
799 QStringList variableValues;
801 QVariantMap::const_iterator it = variables.constBegin();
802 for ( ; it != variables.constEnd(); ++it )
804 variableNames << it.key();
805 variableValues << it.value().toString();
819 const QStringList variableNames = frame->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
820 const QStringList variableValues = frame->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
823 for (
const QString &variableName : variableNames )
825 if ( varIndex >= variableValues.length() )
830 const QVariant varValue = variableValues.at( varIndex );
844 QStringList variableNames = frame->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
845 QStringList variableValues = frame->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
847 variableNames << name;
848 variableValues << value.toString();
859 QStringList variableNames;
860 QStringList variableValues;
862 QVariantMap::const_iterator it = variables.constBegin();
863 for ( ; it != variables.constEnd(); ++it )
865 variableNames << it.key();
866 variableValues << it.value().toString();
887 scope->addFunction( QStringLiteral(
"parameter" ),
new GetProcessingParameterValue( parameters ) );
890 return scope.release();
895 return scope.release();
902 if ( !model->sourceFilePath().isEmpty() )
904 modelPath = model->sourceFilePath();
913 const QString modelFolder = !modelPath.isEmpty() ? QFileInfo( modelPath ).path() : QString();
920 const QVariantMap customVariables = model->variables();
921 for (
auto it = customVariables.constBegin(); it != customVariables.constEnd(); ++it )
926 return modelScope.release();
933 return scope.release();
952 return mUsesGeometry;
958 return mReferencedColumns;
970QgsExpressionContextUtils::GetLayerVisibility::GetLayerVisibility(
const QList<QgsMapLayer *> &layers,
double scale )
972 , mLayers( _qgis_listRawToQPointer( layers ) )
975 for (
const auto &layer : mLayers )
977 if ( layer->hasScaleBasedVisibility() )
979 mScaleBasedVisibilityDetails[ layer ] = qMakePair( layer->minimumScale(), layer->maximumScale() );
984QgsExpressionContextUtils::GetLayerVisibility::GetLayerVisibility()
990 if ( mLayers.isEmpty() )
995 bool isVisible =
false;
997 QgsMapLayer *layer = QgsExpressionUtils::getMapLayer( values.at( 0 ), context, parent );
999 if ( layer && mLayers.contains( layer ) )
1002 if ( mScaleBasedVisibilityDetails.contains( layer ) && !
qgsDoubleNear( mScale, 0.0 ) )
1004 if ( ( !
qgsDoubleNear( mScaleBasedVisibilityDetails[ layer ].first, 0.0 ) && mScale > mScaleBasedVisibilityDetails[ layer ].first ) ||
1005 ( !
qgsDoubleNear( mScaleBasedVisibilityDetails[ layer ].second, 0.0 ) && mScale < mScaleBasedVisibilityDetails[ layer ].second ) )
1017 GetLayerVisibility *func =
new GetLayerVisibility();
1018 func->mLayers = mLayers;
1019 func->mScale = mScale;
1020 func->mScaleBasedVisibilityDetails = mScaleBasedVisibilityDetails;
1032 CurrentVertexZValueExpressionFunction():
1035 QStringLiteral(
"Meshes" ) )
1045 if ( !context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) || !context->
hasVariable( QStringLiteral(
"_mesh_layer" ) ) )
1048 int vertexIndex = context->
variable( QStringLiteral(
"_mesh_vertex_index" ) ).toInt();
1050 QgsMeshLayer *layer = qobject_cast<QgsMeshLayer *>( qvariant_cast<QgsMapLayer *>( context->
variable( QStringLiteral(
"_mesh_layer" ) ) ) );
1070 CurrentVertexXValueExpressionFunction():
1073 QStringLiteral(
"Meshes" ) )
1083 if ( !context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) || !context->
hasVariable( QStringLiteral(
"_mesh_layer" ) ) )
1086 int vertexIndex = context->
variable( QStringLiteral(
"_mesh_vertex_index" ) ).toInt();
1088 QgsMeshLayer *layer = qobject_cast<QgsMeshLayer *>( qvariant_cast<QgsMapLayer *>( context->
variable( QStringLiteral(
"_mesh_layer" ) ) ) );
1108 CurrentVertexYValueExpressionFunction():
1111 QStringLiteral(
"Meshes" ) )
1121 if ( !context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) || !context->
hasVariable( QStringLiteral(
"_mesh_layer" ) ) )
1124 int vertexIndex = context->
variable( QStringLiteral(
"_mesh_vertex_index" ) ).toInt();
1126 QgsMeshLayer *layer = qobject_cast<QgsMeshLayer *>( qvariant_cast<QgsMapLayer *>( context->
variable( QStringLiteral(
"_mesh_layer" ) ) ) );
1146 CurrentVertexExpressionFunction():
1149 QStringLiteral(
"Meshes" ) )
1159 if ( !context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) || !context->
hasVariable( QStringLiteral(
"_mesh_layer" ) ) )
1162 int vertexIndex = context->
variable( QStringLiteral(
"_mesh_vertex_index" ) ).toInt();
1164 QgsMeshLayer *layer = qobject_cast<QgsMeshLayer *>( qvariant_cast<QgsMapLayer *>( context->
variable( QStringLiteral(
"_mesh_layer" ) ) ) );
1184 CurrentVertexIndexExpressionFunction():
1187 QStringLiteral(
"Meshes" ) )
1197 if ( !context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) || !context->
hasVariable( QStringLiteral(
"_mesh_layer" ) ) )
1200 return context->
variable( QStringLiteral(
"_mesh_vertex_index" ) );
1213 CurrentFaceAreaExpressionFunction():
1216 QStringLiteral(
"Meshes" ) )
1226 if ( !context->
hasVariable( QStringLiteral(
"_mesh_face_index" ) ) || !context->
hasVariable( QStringLiteral(
"_mesh_layer" ) ) )
1229 int faceIndex = context->
variable( QStringLiteral(
"_mesh_face_index" ) ).toInt();
1231 QgsMeshLayer *layer = qobject_cast<QgsMeshLayer *>( qvariant_cast<QgsMapLayer *>( context->
variable( QStringLiteral(
"_mesh_layer" ) ) ) );
1236 if ( !face.isEmpty() )
1244 return QVariant( area );
1248 return QVariant( geom.
area() );
1264 CurrentFaceIndexExpressionFunction():
1267 QStringLiteral(
"Meshes" ) )
1277 if ( !context->
hasVariable( QStringLiteral(
"_mesh_face_index" ) ) || !context->
hasVariable( QStringLiteral(
"_mesh_layer" ) ) )
1280 return context->
variable( QStringLiteral(
"_mesh_face_index" ) ).toInt();
1294 std::unique_ptr<QgsExpressionContextScope> scope = std::make_unique<QgsExpressionContextScope>();
1296 switch ( elementType )
1305 scope->addFunction(
"$vertex_as_point",
new CurrentVertexExpressionFunction );
1306 scope->addFunction(
"$vertex_x",
new CurrentVertexXValueExpressionFunction );
1307 scope->addFunction(
"$vertex_y",
new CurrentVertexYValueExpressionFunction );
1308 scope->addFunction(
"$vertex_z",
new CurrentVertexZValueExpressionFunction );
1309 scope->addFunction(
"$vertex_index",
new CurrentVertexIndexExpressionFunction );
1316 scope->addFunction(
"$face_area",
new CurrentFaceAreaExpressionFunction );
1317 scope->addFunction(
"$face_index",
new CurrentFaceIndexExpressionFunction );
1324 return scope.release();
1330 parent->
setEvalErrorString( QObject::tr(
"Invalid arguments for load_layer function" ) );
1344 parent->
setEvalErrorString( QObject::tr(
"load_layer cannot be used in this context" ) );
1350 if ( !uriNode->
isStatic( parent, context ) )
1352 parent->
setEvalErrorString( QObject::tr(
"load_layer requires a static value for the uri argument" ) );
1355 if ( !providerNode->
isStatic( parent, context ) )
1357 parent->
setEvalErrorString( QObject::tr(
"load_layer requires a static value for the provider argument" ) );
1361 const QString uri = uriNode->
eval( parent, context ).toString();
1362 if ( uri.isEmpty() )
1368 const QString providerKey = providerNode->
eval( parent, context ).toString();
1369 if ( providerKey.isEmpty() )
1371 parent->
setEvalErrorString( QObject::tr(
"Invalid provider argument for load_layer" ) );
1378 auto loadLayer = [ uri, providerKey, store, node, parent, &res, &transformContext ]
1383 parent->setEvalErrorString( QObject::tr(
"Invalid provider argument for load_layer" ) );
1389 parent->setEvalErrorString( QObject::tr(
"Cannot use %1 provider for load_layer" ).arg( providerKey ) );
1394 layerOptions.loadAllStoredStyles =
false;
1395 layerOptions.loadDefaultStyle =
false;
1400 parent->setEvalErrorString( QObject::tr(
"Could not load_layer with uri: %1" ).arg( uri ) );
1406 parent->setEvalErrorString( QObject::tr(
"Could not load_layer with uri: %1" ).arg( uri ) );
1410 store->addMapLayer( layer );
1417 if ( QThread::currentThread() == store->thread() )
1420 QMetaObject::invokeMethod( store, loadLayer, Qt::BlockingQueuedConnection );
1429 return new LoadLayerFunction();
static QString version()
Version string.
static QString releaseName()
Release name.
static int versionInt()
Version number used for comparing versions using the "Check QGIS Version" function.
static void setCustomVariables(const QVariantMap &customVariables)
Custom expression variables for this application.
static QString osName()
Returns a string name of the operating system QGIS is running on.
static QString platform()
Returns the QGIS platform name, e.g., "desktop", "server", "qgis_process" or "external" (for external...
static QVariantMap customVariables()
Custom expression variables for this application.
static QString locale()
Returns the QGIS locale.
static void setCustomVariable(const QString &name, const QVariant &value)
Set a single custom expression variable.
static QString userFullName()
Returns the user's operating system login account full display name.
static QString userLoginName()
Returns the user's operating system login account name.
QString toProj() const
Returns a Proj string representation of this CRS.
QString ellipsoidAcronym() const
Returns the ellipsoid acronym for the ellipsoid used by the CRS.
QString projectionAcronym() const
Returns the projection acronym for the projection used by the CRS.
@ WKT_PREFERRED
Preferred format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019,...
QString toWkt(WktVariant variant=WKT1_GDAL, bool multiline=false, int indentationWidth=4) const
Returns a WKT representation of this CRS.
QgsProjOperation operation() const
Returns information about the PROJ operation associated with the coordinate reference system,...
Contains information about the context in which a coordinate transform is executed.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
double measureArea(const QgsGeometry &geometry) const
Measures the area of a geometry.
double convertAreaMeasurement(double area, Qgis::AreaUnit toUnits) const
Takes an area measurement calculated by this QgsDistanceArea object and converts it to a different ar...
Single scope for storing variables and functions for use within a QgsExpressionContext.
void setFields(const QgsFields &fields)
Convenience function for setting a fields for the scope.
void setFeature(const QgsFeature &feature)
Convenience function for setting a feature for the scope.
void addFunction(const QString &name, QgsScopedExpressionFunction *function)
Adds a function to the scope.
void addVariable(const QgsExpressionContextScope::StaticVariable &variable)
Adds a variable into the context scope.
void setVariable(const QString &name, const QVariant &value, bool isStatic=false)
Convenience method for setting a variable in the context scope by name name and value.
static QgsExpressionContextScope * layoutItemScope(const QgsLayoutItem *item)
Creates a new scope which contains variables and functions relating to a QgsLayoutItem.
static void setLayoutMultiFrameVariable(QgsLayoutMultiFrame *frame, const QString &name, const QVariant &value)
Sets a layout multi frame context variable, with the given name and value.
static void setLayerVariable(QgsMapLayer *layer, const QString &name, const QVariant &value)
Sets a layer context variable.
static QgsExpressionContextScope * processingModelAlgorithmScope(const QgsProcessingModelAlgorithm *model, const QVariantMap ¶meters, QgsProcessingContext &context)
Creates a new scope which contains variables and functions relating to a processing model algorithm,...
static QgsExpressionContextScope * updateSymbolScope(const QgsSymbol *symbol, QgsExpressionContextScope *symbolScope=nullptr)
Updates a symbol scope related to a QgsSymbol to an expression context.
static void setProjectVariables(QgsProject *project, const QVariantMap &variables)
Sets all project context variables.
static QgsExpressionContextScope * layoutScope(const QgsLayout *layout)
Creates a new scope which contains variables and functions relating to a QgsLayout layout.
static QgsExpressionContext createFeatureBasedContext(const QgsFeature &feature, const QgsFields &fields)
Helper function for creating an expression context which contains just a feature and fields collectio...
static void removeProjectVariable(QgsProject *project, const QString &name)
Remove project context variable.
static void setLayerVariables(QgsMapLayer *layer, const QVariantMap &variables)
Sets all layer context variables.
static void setGlobalVariables(const QVariantMap &variables)
Sets all global context variables.
static void setLayoutItemVariables(QgsLayoutItem *item, const QVariantMap &variables)
Sets all layout item context variables for an item.
static void setLayoutMultiFrameVariables(QgsLayoutMultiFrame *frame, const QVariantMap &variables)
Sets all layout multiframe context variables for an frame.
static QgsExpressionContextScope * processingAlgorithmScope(const QgsProcessingAlgorithm *algorithm, const QVariantMap ¶meters, QgsProcessingContext &context)
Creates a new scope which contains variables and functions relating to a processing algorithm,...
static QgsExpressionContextScope * notificationScope(const QString &message=QString())
Creates a new scope which contains variables and functions relating to provider notifications.
static QgsExpressionContextScope * projectScope(const QgsProject *project)
Creates a new scope which contains variables and functions relating to a QGIS project.
static QgsExpressionContextScope * parentFormScope(const QgsFeature &formFeature=QgsFeature(), const QString &formMode=QString())
Creates a new scope which contains functions and variables from the current parent attribute form/tab...
static void setLayoutVariable(QgsLayout *layout, const QString &name, const QVariant &value)
Sets a layout context variable.
static QgsExpressionContextScope * formScope(const QgsFeature &formFeature=QgsFeature(), const QString &formMode=QString())
Creates a new scope which contains functions and variables from the current attribute form/table form...
static QgsExpressionContextScope * multiFrameScope(const QgsLayoutMultiFrame *frame)
Creates a new scope which contains variables and functions relating to a QgsLayoutMultiFrame.
static void setLayoutItemVariable(QgsLayoutItem *item, const QString &name, const QVariant &value)
Sets a layout item context variable, with the given name and value.
static QgsExpressionContextScope * mapToolCaptureScope(const QList< QgsPointLocator::Match > &matches)
Sets the expression context variables which are available for expressions triggered by a map tool cap...
static QgsExpressionContextScope * atlasScope(const QgsLayoutAtlas *atlas)
Creates a new scope which contains variables and functions relating to a QgsLayoutAtlas.
static void registerContextFunctions()
Registers all known core functions provided by QgsExpressionContextScope objects.
static QgsExpressionContextScope * mapLayerPositionScope(const QgsPointXY &position)
Sets the expression context variables which are available for expressions triggered by moving the mou...
static void setLayoutVariables(QgsLayout *layout, const QVariantMap &variables)
Sets all layout context variables.
static QgsExpressionContextScope * mapSettingsScope(const QgsMapSettings &mapSettings)
Creates a new scope which contains variables and functions relating to a QgsMapSettings object.
static void removeGlobalVariable(const QString &name)
Remove a global context variable.
static void setGlobalVariable(const QString &name, const QVariant &value)
Sets a global context variable.
static QList< QgsExpressionContextScope * > globalProjectLayerScopes(const QgsMapLayer *layer)
Creates a list of three scopes: global, layer's project and layer.
static QgsExpressionContextScope * meshExpressionScope(QgsMesh::ElementType elementType)
Creates a new scope which contains functions relating to mesh layer element elementType.
static void setProjectVariable(QgsProject *project, const QString &name, const QVariant &value)
Sets a project context variable.
static QgsExpressionContextScope * layerScope(const QgsMapLayer *layer)
Creates a new scope which contains variables and functions relating to a QgsMapLayer.
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...
QgsMapLayerStore * loadedLayerStore() const
Returns the destination layer store for any layers loaded during expression evaluation.
static const QString EXPR_SYMBOL_COLOR
Inbuilt variable name for symbol color variable.
bool hasVariable(const QString &name) const
Check whether a variable is specified by any scope within the context.
static const QString EXPR_SYMBOL_ANGLE
Inbuilt variable name for symbol angle variable.
QVariant variable(const QString &name) const
Fetches a matching variable from the context.
A abstract base class for defining QgsExpression functions.
static bool allParamsStatic(const QgsExpressionNodeFunction *node, QgsExpression *parent, const QgsExpressionContext *context)
This will return true if all the params for the provided function node are static within the constrai...
An expression node for expression functions.
QgsExpressionNode::NodeList * args() const
Returns a list of arguments specified for the function.
QgsExpressionNode * at(int i)
Gets the node at position i in the list.
int count() const
Returns the number of nodes in the list.
Abstract base class for all nodes that can appear in an expression.
QVariant eval(QgsExpression *parent, const QgsExpressionContext *context)
Evaluate this node with the given context and parent.
virtual bool isStatic(QgsExpression *parent, const QgsExpressionContext *context) const =0
Returns true if this node can be evaluated for a static value.
Class for parsing and evaluation of expressions (formerly called "search strings").
static bool registerFunction(QgsExpressionFunction *function, bool transferOwnership=false)
Registers a function to the expression engine.
Qgis::AreaUnit areaUnits() const
Returns the desired areal units for calculations involving geomCalculator(), e.g.,...
void setEvalErrorString(const QString &str)
Sets evaluation error (used internally by evaluation functions)
QgsDistanceArea * geomCalculator()
Returns calculator used for distance and area calculations (used by $length, $area and $perimeter fun...
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.
Container of fields for a vector layer.
A geometry is the spatial representation of a feature.
static QgsGeometry fromRect(const QgsRectangle &rect) SIP_HOLDGIL
Creates a new geometry from a QgsRectangle.
static QgsGeometry fromPointXY(const QgsPointXY &point) SIP_HOLDGIL
Creates a new geometry from a QgsPointXY object.
double area() const
Returns the planar, 2-dimensional area of the geometry.
A representation of the interval between two datetime values.
Class used to render QgsLayout as an atlas, by iterating over the features from an associated vector ...
QString nameForPage(int page) const
Returns the calculated name for a specified atlas page number.
QgsLayout * layout() override
Returns the layout associated with the iterator.
bool enabled() const
Returns whether the atlas generation is enabled.
QString currentFilename() const
Returns the current feature filename.
int count() const override
Returns the number of features to iterate over.
QgsVectorLayer * coverageLayer() const
Returns the coverage layer used for the atlas features.
int currentFeatureNumber() const
Returns the current feature number, where a value of 0 corresponds to the first feature.
Layout graphical items for displaying a map.
Item representing the paper in a layout.
Base class for graphical items within a QgsLayout.
QgsLayoutSize sizeWithUnits() const
Returns the item's current size, including units.
int page() const
Returns the page the item is currently on, with the first page returning 0.
QgsExpressionContext createExpressionContext() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
virtual QString uuid() const
Returns the item identification string.
QString id() const
Returns the item's ID name.
Abstract base class for layout items with the ability to distribute the content to several frames (Qg...
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from the object.
const QgsLayout * layout() const
Returns the layout the object is attached to.
void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for the object.
QPointF pagePositionToLayoutPosition(int page, const QgsLayoutPoint &position) const
Converts a position on a page to an absolute position in layout coordinates.
int pageCount() const
Returns the number of pages in the collection.
QgsLayoutItemPage * page(int pageNumber)
Returns a specific page (by pageNumber) from the collection.
This class provides a method of storing points, consisting of an x and y coordinate,...
double dpi() const
Returns the dpi for outputting the layout.
QgsFeature feature() const
Returns the current feature for evaluating the layout.
QgsVectorLayer * layer() const
Returns the vector layer associated with the layout's context.
QSizeF toQSizeF() const
Converts the layout size to a QSizeF.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for the layout.
QgsLayoutRenderContext & renderContext()
Returns a reference to the layout's render context, which stores information relating to the current ...
QgsLayoutPageCollection * pageCollection()
Returns a pointer to the layout's page collection, which stores and manages page items in the layout.
QVariant customProperty(const QString &key, const QVariant &defaultValue=QVariant()) const
Read a custom property from the layout.
QgsLayoutReportContext & reportContext()
Returns a reference to the layout's report context, which stores information relating to the current ...
static QgsMapLayer * createLayer(const QString &uri, const QString &name, Qgis::LayerType type, const LayerOptions &options, const QString &provider=QString())
Creates a map layer, given a uri, name, layer type and provider name.
Base class for all map layer types.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
QgsCoordinateReferenceSystem crs
QString id() const
Returns the layer's unique ID, which is used to access this layer from QgsProject.
Q_INVOKABLE void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for layer.
The QgsMapSettings class contains configuration for rendering of the map.
Qgis::DistanceUnit mapUnits() const
Returns the units of the map's geographical coordinates - used for scale calculation.
QList< QgsMapLayer * > layers(bool expandGroupLayers=false) const
Returns the list of layers which will be rendered in the map.
double scale() const
Returns the calculated map scale.
long long currentFrame() const
Returns the current frame number of the map, for maps which are part of an animation.
double frameRate() const
Returns the frame rate of the map (in frames per second), for maps which are part of an animation.
QgsRectangle visibleExtent() const
Returns the actual extent derived from requested extent that takes output image size into account.
double rotation() const
Returns the rotation of the resulting map image, in degrees clockwise.
QgsCoordinateReferenceSystem destinationCrs() const
Returns the destination coordinate reference system for the map render.
A marker symbol type, for rendering Point and MultiPoint geometries.
double angle() const
Returns the marker angle for the whole symbol.
Interface for master layout type objects, such as print layouts and reports.
Represents a mesh layer supporting display of data on structured or unstructured meshes.
QgsMesh * nativeMesh()
Returns native mesh (nullptr before rendering or calling to updateMesh)
A class to represent a 2D point.
Point geometry type, with support for z-dimension and m-values.
bool isEmpty() const override SIP_HOLDGIL
Returns true if the geometry is empty.
Abstract base class for processing algorithms.
QString id() const
Returns the unique ID for the algorithm, which is a combination of the algorithm provider's ID and th...
Contains information about the context in which a processing algorithm is executed.
QgsProject * project() const
Returns the project in which the algorithm is being executed.
QString description() const
Description.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
static QgsProject * instance()
Returns the QgsProject singleton instance.
QgsExpressionContextScope * createExpressionContextScope() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
QString absoluteFilePath() const
Returns full absolute path to the project file if the project is stored in a file system - derived fr...
QVariantMap customVariables() const
A map of custom project variables.
void setCustomVariables(const QVariantMap &customVariables)
A map of custom project variables.
QgsProjectStorage * projectStorage() const
Returns pointer to project storage implementation that handles read/write of the project file.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
QgsProviderMetadata * providerMetadata(const QString &providerKey) const
Returns metadata of the provider or nullptr if not found.
double height() const SIP_HOLDGIL
Returns the height of the rectangle.
double width() const SIP_HOLDGIL
Returns the width of the rectangle.
QgsPointXY center() const SIP_HOLDGIL
Returns the center point of the rectangle.
Expression function for use within a QgsExpressionContextScope.
QSet< QString > referencedColumns(const QgsExpressionNodeFunction *node) const override
Returns a set of field names which are required for this function.
virtual QgsScopedExpressionFunction * clone() const =0
Returns a clone of the function.
bool isStatic(const QgsExpressionNodeFunction *node, QgsExpression *parent, const QgsExpressionContext *context) const override
Will be called during prepare to determine if the function is static.
bool usesGeometry(const QgsExpressionNodeFunction *node) const override
Does this function use a geometry object.
QVariant func(const QVariantList &values, const QgsExpressionContext *context, QgsExpression *parent, const QgsExpressionNodeFunction *node) override=0
Returns result of evaluating the function.
Abstract base class for all rendered symbols.
QColor color() const
Returns the symbol's color.
const QgsDateTimeRange & temporalRange() const
Returns the datetime range for the object.
bool isTemporal() const
Returns true if the object's temporal range is enabled, and the object will be filtered when renderin...
static Q_INVOKABLE QString toString(Qgis::DistanceUnit unit)
Returns a translated string representing a distance unit.
Represents a vector layer which manages a vector based data sets.
QgsFields fields() const FINAL
Returns the list of fields of this layer.
static double scaleToZoom(double mapScale, double z0Scale=559082264.0287178)
Finds zoom level given map scale denominator.
static int scaleToZoomLevel(double mapScale, int sourceMinZoom, int sourceMaxZoom, double z0Scale=559082264.0287178)
Finds the best fitting zoom level given a map scale denominator and allowed zoom level range.
double ANALYSIS_EXPORT angle(QgsPoint *p1, QgsPoint *p2, QgsPoint *p3, QgsPoint *p4)
Calculates the angle between two segments (in 2 dimension, z-values are ignored)
CORE_EXPORT QgsGeometry toGeometry(const QgsMeshFace &face, const QVector< QgsMeshVertex > &vertices)
Returns face as polygon geometry.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
#define Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_DEPRECATED_PUSH
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
QPointer< QgsMapLayer > QgsWeakMapLayerPointer
Weak pointer for QgsMapLayer.
QVector< int > QgsMeshFace
List of vertex indexes.
Single variable definition for use within a QgsExpressionContextScope.
Setting options for loading layers.
int vertexCount() const
Returns number of vertices.
QVector< QgsMeshVertex > vertices
QgsMeshFace face(int index) const
Returns a face at the index.
int faceCount() const
Returns number of faces.
ElementType
Defines type of mesh elements.
QgsMeshVertex vertex(int index) const
Returns a vertex at the index.