Class: QgsProcessingModelParameter¶
- class qgis.core.QgsProcessingModelParameter¶
Bases:
QgsProcessingModelComponent
Represents an input parameter used by the model.
QgsProcessingModelParameter(parameterName: str = ‘’) Constructor for
QgsProcessingModelParameter
. The parameter name should match one of the parameters from the parent model.QgsProcessingModelParameter(
QgsProcessingModelParameter
)Methods
- rtype:
QgsProcessingModelParameter
- rtype:
QgsProcessingModelComment
Copies all non-specific definition properties from the
other
component definition.Loads this parameter from a QVariantMap.
Returns the associated parameter name.
Restores the component properties from a QVariantMap.
Saves the component properties to a QVariantMap.
- param comment:
Sets the associated parameter name.
Saves this parameter to a QVariant.
- clone(self) QgsProcessingModelParameter ¶
- Return type:
- comment(self) QgsProcessingModelComment ¶
- Return type:
- copyNonDefinitionProperties(self, other: QgsProcessingModelComponent)¶
Copies all non-specific definition properties from the
other
component definition.This includes properties like the size and position of the component, but not properties like the specific algorithm or input details.
Added in version 3.14.
- loadVariant(self, map: Dict[str, Any]) bool ¶
Loads this parameter from a QVariantMap.
See also
- Parameters:
map (Dict[str)
- Return type:
bool
- parameterName(self) str ¶
Returns the associated parameter name. The parameter name should match one of the parameters from the parent model.
See also
- Return type:
str
- restoreCommonProperties(self, map: Dict[str, Any])¶
Restores the component properties from a QVariantMap.
See also
- saveCommonProperties(self, map: Dict[str, Any])¶
Saves the component properties to a QVariantMap.
See also
- setComment(self, comment: QgsProcessingModelComment)¶
- Parameters:
comment (QgsProcessingModelComment)
- setParameterName(self, name: str)¶
Sets the associated parameter name. The parameter name should match one of the parameters from the parent model.
See also
- Parameters:
name (str)
- toVariant(self) Any ¶
Saves this parameter to a QVariant.
See also
- Return type:
Any