Class: QgsProcessingOutputLayerDefinition

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

class qgis.core.QgsProcessingOutputLayerDefinition[source]

Bases: object

__init__(sink: str | None = '', destinationProject: QgsProject | None = None)

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.

Parameters:

  • sink (Optional[str] = '')

  • destinationProject (Optional[QgsProject] = None)

__init__(sink: QgsProperty, destinationProject: QgsProject | None = 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.

Parameters:
__init__(a0: QgsProcessingOutputLayerDefinition)
Parameters:

a0 (QgsProcessingOutputLayerDefinition)

createOptions: Dict[str, object]
destinationName: str
destinationProject: QgsProject
format(self) → str[source]

Returns the format (if set)

See also

setFormat()

Added in version 4.0.

Return type:

str

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

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

Added in version 3.2.

Parameters:

map (Dict[str, Any])

Return type:

bool

remappingDefinition(self) → QgsRemappingSinkDefinition[source]

Returns the output remapping definition, if useRemapping() is True.

See also

useRemapping()

See also

setRemappingDefinition()

Added in version 3.14.

Return type:

QgsRemappingSinkDefinition

setFormat(self, format: str | None)[source]

Sets the format of the output dataset

See also

format()

Added in version 4.0.

Parameters:

format (Optional[str])

setRemappingDefinition(self, definition: QgsRemappingSinkDefinition)[source]

Sets the remapping definition to use when adding features to the output layer.

Calling this method will set useRemapping() to True.

See also

remappingDefinition()

See also

useRemapping()

Added in version 3.14.

Parameters:

definition (QgsRemappingSinkDefinition)

sink: QgsProperty
toVariant(self) → Any[source]

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

Added in version 3.2.

Return type:

Any

useRemapping(self) → bool[source]

Returns True if the output uses a remapping definition.

See also

remappingDefinition()

Added in version 3.14.

Return type:

bool