Subgroup: Processing

Class: QgsProcessingModelParameter¶

class qgis.core.QgsProcessingModelParameter¶

Bases: qgis._core.QgsProcessingModelComponent

Represents an input parameter used by the model.

New in version 3.0: Methods

`description`	Returns the friendly description text for the component.
`loadVariant`	Loads this parameter from a QVariantMap.
`parameterName`	Returns the associated parameter name.
`position`	Returns the position of the model component within the graphical modeler.
`restoreCommonProperties`
`saveCommonProperties`
`setDescription`	Sets the friendly `description` text for the component.
`setParameterName`	Sets the associated parameter name.
`setPosition`	Sets the `position` of the model component within the graphical modeler.
`toVariant`	Saves this parameter to a QVariant.

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()

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()