Subgroup: Scoped

Class: QgsScopedExpressionFunction

class qgis.core.QgsScopedExpressionFunction(fnname: str, params: int, group: str, helpText: str = '', usesGeometry: bool = False, referencedColumns: Iterable[str] = set(), lazyEval: bool = False, handlesNull: bool = False, isContextual: bool = True)

Bases: qgis._core.QgsExpressionFunction

Create a new QgsScopedExpressionFunction

New in version 2.12.

QgsScopedExpressionFunction(fnname: str, params: object, group: str, helpText: str = ‘’, usesGeometry: bool = False, referencedColumns: Iterable[str] = set(), lazyEval: bool = False, handlesNull: bool = False, isContextual: bool = True) Create a new QgsScopedExpressionFunction using named parameters.

New in version 3.0.

QgsScopedExpressionFunction(QgsScopedExpressionFunction)

Expression function for use within a QgsExpressionContextScope. This differs from a standard QgsExpression.Function in that it requires an implemented clone() method.

New in version 2.12: Methods

allParamsStatic
clone Returns a clone of the function.
func
isStatic
referencedColumns
usesGeometry

Signals

Attributes

allParamsStatic()
clone(self) → QgsScopedExpressionFunction

Returns a clone of the function.

func(self, values: List[Any], context: QgsExpressionContext, parent: QgsExpression, node: QgsExpressionNodeFunction) → Any
isStatic(self, node: QgsExpressionNodeFunction, parent: QgsExpression, context: QgsExpressionContext) → bool
referencedColumns(self, node: QgsExpressionNodeFunction) → Set[str]
usesGeometry(self, node: QgsExpressionNodeFunction) → bool