Class: QgsProcessingParameterRange

class qgis.core.QgsProcessingParameterRange

Bases: QgsProcessingParameterDefinition

A numeric range parameter for processing algorithms.

New in version 3.0.

QgsProcessingParameterRange(name: str, description: str = ‘’, type: QgsProcessingParameterNumber.Type = QgsProcessingParameterNumber.Integer, defaultValue: Any = None, optional: bool = False) Constructor for QgsProcessingParameterRange.

QgsProcessingParameterRange(QgsProcessingParameterRange)

Methods

asPythonString

param outputType

checkValueIsAcceptable

param input

clone

rtype

QgsProcessingParameterDefinition

dataType

Returns the acceptable data type for the range.

fromScriptCode

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

fromVariantMap

param map

setDataType

Sets the acceptable data type for the range.

toVariantMap

rtype

Dict[str, Any]

type

rtype

str

typeName

Returns the type name for the parameter class.

valueAsPythonString

param value

asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass)str
Parameters

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) –

Return type

str

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None)bool
Parameters
Return type

bool

clone(self)QgsProcessingParameterDefinition
Return type

QgsProcessingParameterDefinition

dataType(self)QgsProcessingParameterNumber.Type

Returns the acceptable data type for the range.

See also

setDataType()

Return type

QgsProcessingParameterNumber.Type

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

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

Parameters
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type

QgsProcessingParameterRange

fromVariantMap(self, map: Dict[str, Any])bool
Parameters

map (Dict[str) –

Return type

bool

setDataType(self, dataType: QgsProcessingParameterNumber.Type)

Sets the acceptable data type for the range.

See also

dataType()

Parameters

dataType (QgsProcessingParameterNumber.Type) –

toVariantMap(self)Dict[str, Any]
Return type

Dict[str, Any]

type(self)str
Return type

str

typeName()str

Returns the type name for the parameter class.

Return type

str

valueAsPythonString(self, value: Any, context: QgsProcessingContext)str
Parameters
Return type

str