Class: QgsProcessingParameterMapTheme

A map theme parameter for processing algorithms, allowing users to select an existing map theme from a project.

QgsProcessingParameterMapTheme should be evaluated by calling QgsProcessingAlgorithm.parameterAsString().

Added in version 3.12.

Class Hierarchy

Inheritance diagram of qgis.core.QgsProcessingParameterMapTheme

Base classes

QgsProcessingParameterDefinition

Base class for the definition of processing parameters.

Static Methods

fromScriptCode

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

typeName

Returns the type name for the parameter class.
class qgis.core.QgsProcessingParameterMapTheme[source]

Bases: QgsProcessingParameterDefinition

__init__(name: str | None, description: str | None = '', defaultValue: Any = None, optional: bool = False)

Constructor for QgsProcessingParameterMapTheme.

Parameters:

  • name (Optional[str])

  • description (Optional[str] = '')

  • defaultValue (Any = None)

  • optional (bool = False)

__init__(a0: QgsProcessingParameterMapTheme)
Parameters:

a0 (QgsProcessingParameterMapTheme)

static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) → QgsProcessingParameterMapTheme | None[source]

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[QgsProcessingParameterMapTheme]

static typeName() → str[source]

Returns the type name for the parameter class.

Return type:

str