Subgroup: Processing

Class: QgsProcessingParameterDistance

class qgis.core.QgsProcessingParameterDistance(name: str, description: str = '', defaultValue: Any = None, parentParameterName: str = '', optional: bool = False, minValue: float = -DBL_MAX+1, maxValue: float = DBL_MAX)

Bases: qgis._core.QgsProcessingParameterNumber

Constructor for QgsProcessingParameterDistance.

QgsProcessingParameterDistance(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.

New in version 3.2: Methods

clone
dependsOnOtherParameters
fromVariantMap
parentParameterName Returns the name of the parent parameter, or an empty string if this is not set.
setParentParameterName Sets the name of the parent layer parameter.
toVariantMap
type
typeName Returns the type name for the parameter class.

Signals

Attributes

clone(self) → QgsProcessingParameterDistance
dependsOnOtherParameters(self) → List[str]
fromVariantMap(self, map: Dict[str, Any]) → bool
parentParameterName(self) → str

Returns the name of the parent parameter, or an empty string if this is not set.

setParentParameterName(self, parentParameterName: str)

Sets the name of the parent layer parameter. Use an empty string if this is not required.

toVariantMap(self) → Dict[str, Any]
type(self) → str
typeName() → str

Returns the type name for the parameter class.