Class: QgsProcessingParameterLayout

class qgis.core.QgsProcessingParameterLayout

Bases: QgsProcessingParameterDefinition

A print layout parameter, allowing users to select a print layout.

QgsProcessingParameterLayout should be evaluated by calling QgsProcessingAlgorithm.parameterAsLayout(). This will return the matching layout from the context’s current project. Alternatively, calling QgsProcessingAlgorithm.parameterAsString() will return the name of the target print layout.

New in version 3.8.

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

QgsProcessingParameterLayout(QgsProcessingParameterLayout)

Methods

asPythonString

param outputType:

asScriptCode

rtype:

str

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:

asPythonString(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass) str
Parameters:

outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass) –

Return type:

str

asScriptCode(self) str
Return type:

str

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) QgsProcessingParameterLayout

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

Parameters:
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type:

QgsProcessingParameterLayout

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