Class: QgsProcessingOutputLayerDefinition¶
Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.
List of all members, including inherited members
Methods
Loads this output layer definition from a QVariantMap, wrapped in a QVariant. |
|
Returns the output remapping definition, if |
|
Sets the remapping definition to use when adding features to the output layer. |
|
Saves this output layer definition to a QVariantMap, wrapped in a QVariant. |
|
Returns |
Attributes
- 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
destinationProjectparameter can be set to aQgsProjectinstance 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
destinationProjectparameter can be set to aQgsProjectinstance in which to automatically load the resulting sink/layer after completing processing.- Parameters:
sink (QgsProperty)
destinationProject (Optional[QgsProject] = None)
- __init__(a0: QgsProcessingOutputLayerDefinition)
- Parameters:
- createOptions: Dict[str, object]¶
- destinationName: str¶
- destinationProject: QgsProject¶
- 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
Added in version 3.2.
- Parameters:
map (dict[str, Any])
- Return type:
bool
- remappingDefinition(self) QgsRemappingSinkDefinition[source]¶
Returns the output remapping definition, if
useRemapping()isTrue.See also
See also
Added in version 3.14.
- Return type:
- setRemappingDefinition(self, definition: QgsRemappingSinkDefinition)[source]¶
Sets the remapping
definitionto use when adding features to the output layer.Calling this method will set
useRemapping()toTrue.See also
See also
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
Added in version 3.2.
- Return type: