Subgroup: Processing

Class: QgsProcessingModelParameter

class qgis.core.QgsProcessingModelParameter(parameterName: str = '')

Bases: qgis._core.QgsProcessingModelComponent

Constructor for QgsProcessingModelParameter. The parameter name should match one of the parameters from the parent model.

QgsProcessingModelParameter(QgsProcessingModelParameter)

Represents an input parameter used by the model.

New in version 3.0: Methods

loadVariant Loads this parameter from a QVariantMap.
parameterName Returns the associated parameter name.
restoreCommonProperties
saveCommonProperties
setParameterName Sets the associated parameter name.
toVariant Saves this parameter to a QVariant.

Signals

Attributes

loadVariant(self, map: Dict[str, Any]) → bool

Loads this parameter from a QVariantMap.

See also

toVariant()

parameterName(self) → str

Returns the associated parameter name. The parameter name should match one of the parameters from the parent model.

See also

parameterName()

restoreCommonProperties()
saveCommonProperties()
setParameterName(self, name: str)

Sets the associated parameter name. The parameter name should match one of the parameters from the parent model.

See also

parameterName()

toVariant(self) → Any

Saves this parameter to a QVariant.

See also

loadVariant()