Class: QgsProcessingParameterRange¶
- class qgis.core.QgsProcessingParameterRange(name: str, description: str = '', type: QgsProcessingParameterNumber.Type = QgsProcessingParameterNumber.Integer, defaultValue: Any = None, optional: bool = False)¶
Bases:
QgsProcessingParameterDefinition
Constructor for QgsProcessingParameterRange.
QgsProcessingParameterRange(
QgsProcessingParameterRange
)A numeric range parameter for processing algorithms.
Methods
- param outputType
- param input
- rtype
QgsProcessingParameterDefinition
Returns the acceptable data type for the range.
Creates a new parameter using the definition from a script code.
- param map
Sets the acceptable data
type
for the range.- rtype
Dict[str, Any]
- rtype
str
Returns the type name for the parameter class.
- 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
input (Any) –
context (
QgsProcessingContext
= None) –
- Return type
bool
- clone(self) → QgsProcessingParameterDefinition¶
- Return type
- dataType(self) → QgsProcessingParameterNumber.Type¶
Returns the acceptable data type for the range.
See also
- Return 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
- 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
- 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
value (Any) –
context (QgsProcessingContext) –
- Return type
str