Class: QgsProcessingGuiUtils

Contains utility functions relating to Processing GUI components.

Warning

This is not considered stable API, and is exposed to Python for internal use only.

Added in version 3.44.

Static Methods

addResultLayers

Responsible for adding layers created by an algorithm to a project and the project's layer tree in the correct location.

configureResultLayerTreeLayer

Applies post-processing steps to the QgsLayerTreeLayer created for an algorithm's output.

layerTreeResultsGroup

Returns the destination layer tree group to store results in, or None if there is no specific destination tree group associated with the layer.
class qgis.gui.QgsProcessingGuiUtils[source]

Bases: object

class ResultLayerDetails[source]

Bases: object

Contains details of a layer result from running an algorithm.

Added in version 3.44.

QgsProcessingGuiUtils.ResultLayerDetails(layer: Optional[QgsMapLayer]) Constructor for ResultLayerDetails.

Takes ownership of layer.

QgsProcessingGuiUtils.ResultLayerDetails(a0: QgsProcessingGuiUtils.ResultLayerDetails)

destinationProject

Destination QGIS project.

layer

Associated map layer.

sortKey

Sort order key for ordering output layers in the layer tree.

targetLayerTreeGroup

Optional target layer tree group, where the layer should be placed.

static addResultLayers(layers: Iterable[QgsProcessingGuiUtils.ResultLayerDetails], context: QgsProcessingContext, view: QgsLayerTreeView | None = None)[source]

Responsible for adding layers created by an algorithm to a project and the project’s layer tree in the correct location.

Parameters:
static configureResultLayerTreeLayer(layerTreeLayer: QgsLayerTreeLayer | None)[source]

Applies post-processing steps to the QgsLayerTreeLayer created for an algorithm’s output.

Parameters:

layerTreeLayer (Optional[QgsLayerTreeLayer])

static layerTreeResultsGroup(layerDetails: QgsProcessingContext.LayerDetails, context: QgsProcessingContext) → QgsLayerTreeGroup | None[source]

Returns the destination layer tree group to store results in, or None if there is no specific destination tree group associated with the layer.

Parameters:
Return type:

Optional[QgsLayerTreeGroup]