Class: 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.

The number of decimals places shown in a distance parameter’s widget can be specified by setting the parameter’s metadata. For example:

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

Added in version 3.2.

Class Hierarchy¶

Base classes¶

`QgsProcessingParameterNumber`	A numeric parameter for processing algorithms.
`QgsProcessingParameterDefinition`	Base class for the definition of processing parameters.

Methods

`defaultUnit`	Returns the default distance unit for the parameter.
`parentParameterName`	Returns the name of the parent parameter, or an empty string if this is not set.
`setDefaultUnit`	Sets the default distance unit for the parameter.
`setParentParameterName`	Sets the name of the parent layer parameter.

class qgis.core.QgsProcessingParameterDistance[source]¶

Bases: QgsProcessingParameterNumber

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