Class: QgsProcessingParameterLayout¶
-
class
qgis.core.
QgsProcessingParameterLayout
(name: str, description: str = '', defaultValue: Any = None, optional: bool = False)¶ Bases:
QgsProcessingParameterDefinition
Constructor for QgsProcessingParameterLayout.
QgsProcessingParameterLayout(
QgsProcessingParameterLayout
)A print layout parameter, allowing users to select a print layout.
QgsProcessingParameterLayout
should be evaluated by callingQgsProcessingAlgorithm.parameterAsLayout()
. This will return the matching layout from the context’s current project. Alternatively, callingQgsProcessingAlgorithm.parameterAsString()
will return the name of the target print layout.New in version 3.8.
- Parameters
name (str) –
description (str = '') –
defaultValue (Any = None) –
optional –
-
asPythonString
(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str¶ - Parameters
outputType (QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) –
- Return type
str
-
asScriptCode
(self) → str¶ - Return type
str
-
clone
(self) → QgsProcessingParameterDefinition¶ - Return type
-
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
-
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
value (Any) –
context (QgsProcessingContext) –
- Return type
str