Class: QgsProcessingParameterRange¶
- class qgis.core.QgsProcessingParameterRange¶
Bases:
QgsProcessingParameterDefinition
A numeric range parameter for processing algorithms.
QgsProcessingParameterRange(name: Optional[str], description: Optional[str] = ‘’, type: Qgis.ProcessingNumberParameterType = Qgis.ProcessingNumberParameterType.Integer, defaultValue: Any = None, optional: bool = False) Constructor for QgsProcessingParameterRange.
QgsProcessingParameterRange(a0:
QgsProcessingParameterRange
)Methods
- param outputType:
- param input:
- rtype:
Optional[QgsProcessingParameterDefinition]
Returns the acceptable data type for the range.
Default gui value for an algorithm parameter from settings
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.PythonOutputType.PythonQgsProcessingAlgorithmSubclass) str ¶
- Parameters:
outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass)
- Return type:
str
- checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext | None = None) bool ¶
- Parameters:
input (Any)
context (Optional[QgsProcessingContext] = None)
- Return type:
bool
- clone(self) QgsProcessingParameterDefinition | None ¶
- Return type:
Optional[QgsProcessingParameterDefinition]
- dataType(self) Qgis.ProcessingNumberParameterType ¶
Returns the acceptable data type for the range.
See also
- Return type:
- defaultGuiValueFromSetting(self) Any ¶
Default gui value for an algorithm parameter from settings
- Returns:
default value from settings or invalid QVariant if there is no default value defined in the settings
Added in version 3.34.
- fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) QgsProcessingParameterRange | None ¶
Creates a new parameter using the definition from a script code.
- Parameters:
name (Optional[str])
description (Optional[str])
isOptional (bool)
definition (Optional[str])
- Return type:
Optional[QgsProcessingParameterRange]
- fromVariantMap(self, map: Dict[str, Any]) bool ¶
- Parameters:
map (Dict[str)
- Return type:
bool
- setDataType(self, dataType: Qgis.ProcessingNumberParameterType)¶
Sets the acceptable data
type
for the range.See also
- Parameters:
dataType (Qgis.ProcessingNumberParameterType)
- 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