Class: QgsProcessingParameterNumber¶

A numeric parameter for processing algorithms.

For numeric parameters with a dataType() of Double, the number of decimals places shown in the parameter’s widget can be specified by setting the parameter’s metadata. For example:

param = QgsProcessingParameterNumber( 'VAL', 'Threshold', type=QgsProcessingParameterNumber.Double)
# only show two decimal places in parameter's widgets, not 6:
param.setMetadata( {'widget_wrapper':
  { 'decimals': 2 }
})

Class Hierarchy¶

Base classes¶

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

Subclasses¶

`QgsProcessingParameterArea`	A double numeric parameter for area values. Linked to a source layer or CRS parameter to determine what units the area values are in.
`QgsProcessingParameterDistance`	A double numeric parameter for distance values. Linked to a source layer or CRS parameter to determine what units the distance values are in.
`QgsProcessingParameterDuration`	A double numeric parameter for duration values. The returned value will always be in milliseconds.
`QgsProcessingParameterScale`	A double numeric parameter for map scale values.
`QgsProcessingParameterVolume`	A double numeric parameter for volume values. Linked to a source layer or CRS parameter to determine what units the volume values are in.

Enums

Type

alias of ProcessingNumberParameterType

Methods

`dataType`	Returns the acceptable data type for the parameter.
`maximum`	Returns the maximum value acceptable by the parameter.
`minimum`	Returns the minimum value acceptable by the parameter.
`setDataType`	Sets the acceptable data type for the parameter.
`setMaximum`	Sets the maximum value acceptable by the parameter.
`setMinimum`	Sets the minimum value acceptable by the parameter.

Static Methods

`fromScriptCode`	Creates a new parameter using the definition from a script code.
`typeName`	Returns the type name for the parameter class.

class qgis.core.QgsProcessingParameterNumber[source]¶

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '', type: Qgis.ProcessingNumberParameterType = Qgis.ProcessingNumberParameterType.Integer, defaultValue: Any = None, optional: bool = False, minValue: float = -DBL_MAX + 1, maxValue: float = DBL_MAX)

Constructor for QgsProcessingParameterNumber.

Parameters:

name (Optional[str])
description (Optional[str] = '')
type (Qgis.ProcessingNumberParameterType = Qgis.ProcessingNumberParameterType.Integer)
defaultValue (Any = None)
optional (bool = False)
minValue (float = -DBL_MAX+1)
maxValue (float = DBL_MAX)

__init__(a0: QgsProcessingParameterNumber)

Parameters:: a0 (QgsProcessingParameterNumber)

Type¶: alias of ProcessingNumberParameterType

dataType(self) → Qgis.ProcessingNumberParameterType[source]¶

Returns the acceptable data type for the parameter.

See also

setDataType()

Return type:: Qgis.ProcessingNumberParameterType

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterNumber | None[source]¶