Class: QgsExpressionNodeFunction¶
- class qgis.core.QgsExpressionNodeFunction(fnIndex: int, args: QgsExpressionNode.NodeList)¶
Bases:
QgsExpressionNode
A function node consists of an index of the function in the global function array and a list of arguments that will be passed to it.
QgsExpressionNodeFunction(
QgsExpressionNodeFunction
)An expression node for expression functions.
Methods
Returns a list of arguments specified for the function.
- rtype
QgsExpressionNode
- rtype
str
- param parent
Returns the index of the node’s function.
- param parent
- rtype
QgsExpressionNode.NodeType
- param parent
- rtype
Set[str]
- rtype
Set[str]
- rtype
Set[str]
Tests whether the provided argument list is valid for the matching function
- args(self) → QgsExpressionNode.NodeList¶
Returns a list of arguments specified for the function.
- Return type
- clone(self) → QgsExpressionNode¶
- Return type
- dump(self) → str¶
- Return type
str
- evalNode(self, parent: QgsExpression, context: QgsExpressionContext) → Any¶
- Parameters
parent (QgsExpression) –
context (QgsExpressionContext) –
- Return type
Any
- fnIndex(self) → int¶
Returns the index of the node’s function.
- Return type
int
- isStatic(self, parent: QgsExpression, context: QgsExpressionContext) → bool¶
- Parameters
parent (QgsExpression) –
context (QgsExpressionContext) –
- Return type
bool
- nodeType(self) → QgsExpressionNode.NodeType¶
- Return type
- prepareNode(self, parent: QgsExpression, context: QgsExpressionContext) → bool¶
- Parameters
parent (QgsExpression) –
context (QgsExpressionContext) –
- Return type
bool
- referencedColumns(self) → Set[str]¶
- Return type
Set[str]
- referencedFunctions(self) → Set[str]¶
- Return type
Set[str]
- referencedVariables(self) → Set[str]¶
- Return type
Set[str]
- validateParams(fnIndex: int, args: QgsExpressionNode.NodeList, error: str) → bool¶
Tests whether the provided argument list is valid for the matching function
- Parameters
fnIndex (int) –
args (QgsExpressionNode.NodeList) –
error (str) –
- Return type
bool