Class: QgsProcessingParameterRange

class qgis.core.QgsProcessingParameterRange(name: str, description: str = '', type: QgsProcessingParameterNumber.Type = QgsProcessingParameterNumber.Integer, defaultValue: Any = None, optional: bool = False)

Bases: qgis._core.QgsProcessingParameterDefinition

Constructor for QgsProcessingParameterRange.

QgsProcessingParameterRange(QgsProcessingParameterRange)

A numeric range parameter for processing algorithms.

New in version 3.0: Enums

Methods

asPythonString
checkValueIsAcceptable
clone
dataType Returns the acceptable data type for the range.
fromScriptCode Creates a new parameter using the definition from a script code.
fromVariantMap
setDataType Sets the acceptable data type for the range.
toVariantMap
type
typeName Returns the type name for the parameter class.
valueAsPythonString

Signals

Attributes

asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str
checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) → bool
clone(self) → QgsProcessingParameterDefinition
dataType(self) → QgsProcessingParameterNumber.Type

Returns the acceptable data type for the range.

See also

setDataType()

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterRange

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

fromVariantMap(self, map: Dict[str, Any]) → bool
setDataType(self, dataType: QgsProcessingParameterNumber.Type)

Sets the acceptable data type for the range.

See also

dataType()

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