Class: QgsProcessingParameterPoint

class qgis.core.QgsProcessingParameterPoint

Bases: QgsProcessingParameterDefinition

A point parameter for processing algorithms.

Added in version 3.0.

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

QgsProcessingParameterPoint(a0: QgsProcessingParameterPoint)

Methods

checkValueIsAcceptable

param input:

clone

rtype:

Optional[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 = None) → bool
Parameters:
Return type:

bool

clone(self) → QgsProcessingParameterDefinition | None
Return type:

Optional[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

Added in version 3.34.

fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterPoint | 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[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