Class: QgsProcessingOutputLayerDefinition

class qgis.core.QgsProcessingOutputLayerDefinition(sink: str = '', destinationProject: QgsProject = None)

Bases: sip.wrapper

Constructor for QgsProcessingOutputLayerDefinition, accepting a static sink/layer string. The destinationProject parameter can be set to a QgsProject instance in which to automatically load the resulting sink/layer after completing processing.

QgsProcessingOutputLayerDefinition(sink: QgsProperty, destinationProject: QgsProject = None) Constructor for QgsProcessingOutputLayerDefinition, accepting a QgsProperty sink/layer. The destinationProject parameter can be set to a QgsProject instance in which to automatically load the resulting sink/layer after completing processing.

QgsProcessingOutputLayerDefinition(QgsProcessingOutputLayerDefinition)

Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.

New in version 3.0.

Parameters

• sink (str = '') –

• destinationProject –

createOptions

destinationName

destinationProject

loadVariant(self, map: Dict[str, Any]) → bool

Loads this output layer definition from a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils.readVariant to load it from an XML document.

See also

toVariant()

New in version 3.2.

Parameters

map (Dict[str) –

Return type

bool

sink

toVariant(self) → Any

Saves this output layer definition to a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils.writeVariant to save it to an XML document.

See also

loadVariant()

New in version 3.2.

Return type

Any