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();
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->serverProperties()->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 );
399 const QgsVectorLayer *vLayer = qobject_cast< const QgsVectorLayer * >( layer );
414 QList<QgsExpressionContextScope *> scopes;
433 QStringList variableNames = layer->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
434 QStringList variableValues = layer->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
436 variableNames << name;
437 variableValues << value.toString();
448 QStringList variableNames;
449 QStringList variableValues;
451 QVariantMap::const_iterator it = variables.constBegin();
452 for ( ; it != variables.constEnd(); ++it )
454 variableNames << it.key();
455 variableValues << it.value().toString();
509 QVariantList layersIds;
511 const QList<QgsMapLayer *> layersInMap = mapSettings.
layers(
true );
512 layersIds.reserve( layersInMap.count() );
513 layers.reserve( layersInMap.count() );
516 layersIds << layer->id();
529 scope->
addFunction( QStringLiteral(
"is_layer_visible" ),
new GetLayerVisibility( mapSettings.
layers(
true ), mapSettings.
scale() ) );
560 QVariantList matchList;
564 QVariantMap matchMap;
566 matchMap.insert( QStringLiteral(
"valid" ), match.isValid() );
567 matchMap.insert( QStringLiteral(
"layer" ), QVariant::fromValue<QgsWeakMapLayerPointer>(
QgsWeakMapLayerPointer( match.layer() ) ) );
568 matchMap.insert( QStringLiteral(
"feature_id" ), match.featureId() );
569 matchMap.insert( QStringLiteral(
"vertex_index" ), match.vertexIndex() );
570 matchMap.insert( QStringLiteral(
"distance" ), match.distance() );
572 matchList.append( matchMap );
598 angle = markerSymbol->
angle();
609 return scope.release();
612 const QStringList variableNames = layout->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
613 const QStringList variableValues = layout->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
617 for (
const QString &variableName : variableNames )
619 if ( varIndex >= variableValues.length() )
624 const QVariant varValue = variableValues.at( varIndex );
626 scope->setVariable( variableName, varValue );
642 QVariantList offsets;
652 scope->addFunction( QStringLiteral(
"item_variables" ),
new GetLayoutItemVariables( layout ) );
653 scope->addFunction( QStringLiteral(
"map_credits" ),
new GetLayoutMapLayerCredits( layout ) );
665 scope->setFeature( atlasFeature );
671 return scope.release();
680 QStringList variableNames = layout->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
681 QStringList variableValues = layout->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
683 variableNames << name;
684 variableValues << value.toString();
695 QStringList variableNames;
696 QStringList variableValues;
698 QVariantMap::const_iterator it = variables.constBegin();
699 for ( ; it != variables.constEnd(); ++it )
701 variableNames << it.key();
702 variableValues << it.value().toString();
755 const QStringList variableNames = item->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
756 const QStringList variableValues = item->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
759 for (
const QString &variableName : variableNames )
761 if ( varIndex >= variableValues.length() )
766 const QVariant varValue = variableValues.at( varIndex );
801 QStringList variableNames = item->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
802 QStringList variableValues = item->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
804 variableNames << name;
805 variableValues << value.toString();
816 QStringList variableNames;
817 QStringList variableValues;
819 QVariantMap::const_iterator it = variables.constBegin();
820 for ( ; it != variables.constEnd(); ++it )
822 variableNames << it.key();
823 variableValues << it.value().toString();
837 const QStringList variableNames = frame->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
838 const QStringList variableValues = frame->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
841 for (
const QString &variableName : variableNames )
843 if ( varIndex >= variableValues.length() )
848 const QVariant varValue = variableValues.at( varIndex );
862 QStringList variableNames = frame->
customProperty( QStringLiteral(
"variableNames" ) ).toStringList();
863 QStringList variableValues = frame->
customProperty( QStringLiteral(
"variableValues" ) ).toStringList();
865 variableNames << name;
866 variableValues << value.toString();
877 QStringList variableNames;
878 QStringList variableValues;
880 QVariantMap::const_iterator it = variables.constBegin();
881 for ( ; it != variables.constEnd(); ++it )
883 variableNames << it.key();
884 variableValues << it.value().toString();
905 scope->addFunction( QStringLiteral(
"parameter" ),
new GetProcessingParameterValue( parameters ) );
908 return scope.release();
913 return scope.release();
920 if ( !model->sourceFilePath().isEmpty() )
922 modelPath = model->sourceFilePath();
931 const QString modelFolder = !modelPath.isEmpty() ? QFileInfo( modelPath ).path() : QString();
938 const QVariantMap customVariables = model->variables();
939 for (
auto it = customVariables.constBegin(); it != customVariables.constEnd(); ++it )
944 return modelScope.release();
951 return scope.release();
971 return mUsesGeometry;
977 return mReferencedColumns;
989QgsExpressionContextUtils::GetLayerVisibility::GetLayerVisibility(
const QList<QgsMapLayer *> &layers,
double scale )
991 , mLayers( _qgis_listRawToQPointer( layers ) )
994 for (
const auto &layer : mLayers )
996 if ( layer->hasScaleBasedVisibility() )
998 mScaleBasedVisibilityDetails[ layer ] = qMakePair( layer->minimumScale(), layer->maximumScale() );
1003QgsExpressionContextUtils::GetLayerVisibility::GetLayerVisibility()
1009 if ( mLayers.isEmpty() )
1014 bool isVisible =
false;
1016 QgsMapLayer *layer = QgsExpressionUtils::getMapLayer( values.at( 0 ), context, parent );
1018 if ( layer && mLayers.contains( layer ) )
1021 if ( mScaleBasedVisibilityDetails.contains( layer ) && !
qgsDoubleNear( mScale, 0.0 ) )
1023 if ( ( !
qgsDoubleNear( mScaleBasedVisibilityDetails[ layer ].first, 0.0 ) && mScale > mScaleBasedVisibilityDetails[ layer ].first ) ||
1024 ( !
qgsDoubleNear( mScaleBasedVisibilityDetails[ layer ].second, 0.0 ) && mScale < mScaleBasedVisibilityDetails[ layer ].second ) )
1036 GetLayerVisibility *func =
new GetLayerVisibility();
1037 func->mLayers = mLayers;
1038 func->mScale = mScale;
1039 func->mScaleBasedVisibilityDetails = mScaleBasedVisibilityDetails;
1051 CurrentVertexZValueExpressionFunction():
1054 QStringLiteral(
"Meshes" ) )
1062 context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) &&
1063 context->
hasVariable( QStringLiteral(
"_native_mesh" ) ) )
1065 int vertexIndex = context->
variable( QStringLiteral(
"_mesh_vertex_index" ) ).toInt();
1066 const QgsMesh nativeMesh = qvariant_cast<QgsMesh>( context->
variable( QStringLiteral(
"_native_mesh" ) ) );
1084 CurrentVertexXValueExpressionFunction():
1087 QStringLiteral(
"Meshes" ) )
1095 context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) &&
1096 context->
hasVariable( QStringLiteral(
"_native_mesh" ) ) )
1098 int vertexIndex = context->
variable( QStringLiteral(
"_mesh_vertex_index" ) ).toInt();
1099 const QgsMesh nativeMesh = qvariant_cast<QgsMesh>( context->
variable( QStringLiteral(
"_native_mesh" ) ) );
1117 CurrentVertexYValueExpressionFunction():
1120 QStringLiteral(
"Meshes" ) )
1128 context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) &&
1129 context->
hasVariable( QStringLiteral(
"_native_mesh" ) ) )
1131 int vertexIndex = context->
variable( QStringLiteral(
"_mesh_vertex_index" ) ).toInt();
1132 const QgsMesh nativeMesh = qvariant_cast<QgsMesh>( context->
variable( QStringLiteral(
"_native_mesh" ) ) );
1150 CurrentVertexExpressionFunction():
1153 QStringLiteral(
"Meshes" ) )
1161 context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) &&
1162 context->
hasVariable( QStringLiteral(
"_native_mesh" ) ) )
1164 int vertexIndex = context->
variable( QStringLiteral(
"_mesh_vertex_index" ) ).toInt();
1165 const QgsMesh nativeMesh = qvariant_cast<QgsMesh>( context->
variable( QStringLiteral(
"_native_mesh" ) ) );
1183 CurrentVertexIndexExpressionFunction():
1186 QStringLiteral(
"Meshes" ) )
1196 if ( !context->
hasVariable( QStringLiteral(
"_mesh_vertex_index" ) ) )
1199 return context->
variable( QStringLiteral(
"_mesh_vertex_index" ) );
1212 CurrentFaceAreaExpressionFunction():
1215 QStringLiteral(
"Meshes" ) )
1223 context->
hasVariable( QStringLiteral(
"_mesh_face_index" ) ) &&
1224 context->
hasVariable( QStringLiteral(
"_native_mesh" ) ) )
1226 const int faceIndex = context->
variable( QStringLiteral(
"_mesh_face_index" ) ).toInt();
1227 const QgsMesh nativeMesh = qvariant_cast<QgsMesh>( context->
variable( QStringLiteral(
"_native_mesh" ) ) );
1229 if ( !face.isEmpty() )
1239 return QVariant( area );
1243 parent->
setEvalErrorString( QObject::tr(
"An error occurred while calculating area" ) );
1249 return QVariant( geom.
area() );
1266 CurrentFaceIndexExpressionFunction():
1269 QStringLiteral(
"Meshes" ) )
1279 if ( !context->
hasVariable( QStringLiteral(
"_mesh_face_index" ) ) )
1282 return context->
variable( QStringLiteral(
"_mesh_face_index" ) ).toInt();
1296 std::unique_ptr<QgsExpressionContextScope> scope = std::make_unique<QgsExpressionContextScope>();
1298 switch ( elementType )
1307 scope->addFunction(
"$vertex_as_point",
new CurrentVertexExpressionFunction );
1308 scope->addFunction(
"$vertex_x",
new CurrentVertexXValueExpressionFunction );
1309 scope->addFunction(
"$vertex_y",
new CurrentVertexYValueExpressionFunction );
1310 scope->addFunction(
"$vertex_z",
new CurrentVertexZValueExpressionFunction );
1311 scope->addFunction(
"$vertex_index",
new CurrentVertexIndexExpressionFunction );
1318 scope->addFunction(
"$face_area",
new CurrentFaceAreaExpressionFunction );
1319 scope->addFunction(
"$face_index",
new CurrentFaceIndexExpressionFunction );
1326 return scope.release();
1332 parent->
setEvalErrorString( QObject::tr(
"Invalid arguments for load_layer function" ) );
1346 parent->
setEvalErrorString( QObject::tr(
"load_layer cannot be used in this context" ) );
1352 if ( !uriNode->
isStatic( parent, context ) )
1354 parent->
setEvalErrorString( QObject::tr(
"load_layer requires a static value for the uri argument" ) );
1357 if ( !providerNode->
isStatic( parent, context ) )
1359 parent->
setEvalErrorString( QObject::tr(
"load_layer requires a static value for the provider argument" ) );
1363 const QString uri = uriNode->
eval( parent, context ).toString();
1364 if ( uri.isEmpty() )
1370 const QString providerKey = providerNode->
eval( parent, context ).toString();
1371 if ( providerKey.isEmpty() )
1373 parent->
setEvalErrorString( QObject::tr(
"Invalid provider argument for load_layer" ) );
1380 auto loadLayer = [ uri, providerKey, store, node, parent, &res, &transformContext ]
1385 parent->setEvalErrorString( QObject::tr(
"Invalid provider argument for load_layer" ) );
1391 parent->setEvalErrorString( QObject::tr(
"Cannot use %1 provider for load_layer" ).arg( providerKey ) );
1396 layerOptions.loadAllStoredStyles =
false;
1397 layerOptions.loadDefaultStyle =
false;
1402 parent->setEvalErrorString( QObject::tr(
"Could not load_layer with uri: %1" ).arg( uri ) );
1408 parent->setEvalErrorString( QObject::tr(
"Could not load_layer with uri: %1" ).arg( uri ) );
1412 store->addMapLayer( layer );
1419 if ( QThread::currentThread() == store->thread() )
1422 QMetaObject::invokeMethod( store, loadLayer, Qt::BlockingQueuedConnection );
1431 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.
@ Preferred
Preferred format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019,...
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.
This class represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
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.
QString toWkt(Qgis::CrsWktVariant variant=Qgis::CrsWktVariant::Wkt1Gdal, 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.
Custom exception class for Coordinate Reference System related exceptions.
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...
QgsRange which stores a range of double values.
bool isInfinite() const
Returns true if the range consists of all possible values.
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.
QVariantMap variablesToMap() const
Returns a map of variable name to value representing all the expression variables contained by the co...
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)
Creates a new geometry from a QgsRectangle.
static QgsGeometry fromPointXY(const QgsPointXY &point)
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
Q_INVOKABLE void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for layer.
QgsCoordinateReferenceSystem verticalCrs
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.
QgsDoubleRange zRange() const
Returns the range of z-values which will be visible in the map.
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.
A class to represent a 2D point.
Point geometry type, with support for z-dimension and m-values.
bool isEmpty() const override
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.
T lower() const
Returns the lower bound of the range.
T upper() const
Returns the upper bound of the range.
double width() const
Returns the width of the rectangle.
QgsPointXY center() const
Returns the center point of the rectangle.
double height() const
Returns the height 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...
T begin() const
Returns the beginning of the range.
T end() const
Returns the upper bound of the range.
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.
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.
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.
Mesh - vertices, edges and faces.
QVector< QgsMeshVertex > vertices
QgsMeshFace face(int index) const
Returns a face at the index.
ElementType
Defines type of mesh elements.
QgsMeshVertex vertex(int index) const
Returns a vertex at the index.