Class: QgsProcessingParameterEnum

class qgis.core.QgsProcessingParameterEnum(name: str, description: str = '', options: Iterable[str] = [], allowMultiple: bool = False, defaultValue: Any = None, optional: bool = False)

Bases: qgis._core.QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterEnum.

QgsProcessingParameterEnum(QgsProcessingParameterEnum)

An enum based parameter for processing algorithms, allowing for selection from predefined values.

New in version 3.0: Methods

allowMultiple Returns true if the parameter allows multiple selected values.
asScriptCode
checkValueIsAcceptable
clone
fromScriptCode Creates a new parameter using the definition from a script code.
fromVariantMap
options Returns the list of acceptable options for the parameter.
setAllowMultiple Sets whether the parameter allows multiple selected values.
setOptions Sets the list of acceptable options for the parameter.
toVariantMap
type
typeName Returns the type name for the parameter class.
valueAsPythonString

Signals

Attributes

allowMultiple(self) → bool

Returns true if the parameter allows multiple selected values.

asScriptCode(self) → str
checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
clone(self) → QgsProcessingParameterDefinition
fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterEnum

Creates a new parameter using the definition from a script code.

fromVariantMap(self, map: Dict[str, Any]) → bool
options(self) → List[str]

Returns the list of acceptable options for the parameter.

See also

setOptions()

setAllowMultiple(self, allowMultiple: bool)

Sets whether the parameter allows multiple selected values.

See also

allowMultiple()

setOptions(self, options: Iterable[str])

Sets the list of acceptable options for the parameter.

See also

options()

toVariantMap(self) → Dict[str, Any]
type(self) → str
typeName() → str

Returns the type name for the parameter class.

valueAsPythonString(self, value: Any, context: QgsProcessingContext) → str