Class: QgsProcessingParameterPoint

class qgis.core.QgsProcessingParameterPoint

Bases: QgsProcessingParameterDefinition

A point parameter for processing algorithms.

QgsProcessingParameterPoint(name: str, description: str = ‘’, defaultValue: Any = None, optional: bool = False) Constructor for QgsProcessingParameterPoint.

QgsProcessingParameterPoint(QgsProcessingParameterPoint)

Methods

checkValueIsAcceptable

param input:

clone

rtype:

QgsProcessingParameterDefinition

defaultGuiValueFromSetting

Default gui value for an algorithm parameter from settings

fromScriptCode

Creates a new parameter using the definition from a script code.

type

rtype:

str

typeName

Returns the type name for the parameter class.

valueAsPythonString

param value:

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None) bool
Parameters:
Return type:

bool

clone(self) QgsProcessingParameterDefinition
Return type:

QgsProcessingParameterDefinition

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

New in version 3.34.

fromScriptCode(name: str, description: str, isOptional: bool, definition: str) QgsProcessingParameterPoint

Creates a new parameter using the definition from a script code.

Parameters:
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type:

QgsProcessingParameterPoint

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:
Return type:

str