Class: QgsProcessingOutputLayerDefinition¶
-
class
qgis.core.
QgsProcessingOutputLayerDefinition
¶ Bases:
sip.wrapper
Encapsulates settings relating to a feature sink or output raster layer for a processing algorithm.
New in version 3.0.
QgsProcessingOutputLayerDefinition(sink: str = ‘’, destinationProject:
QgsProject
= None) Constructor forQgsProcessingOutputLayerDefinition
, accepting a static sink/layer string. ThedestinationProject
parameter can be set to aQgsProject
instance in which to automatically load the resulting sink/layer after completing processing.QgsProcessingOutputLayerDefinition(sink:
QgsProperty
, destinationProject:QgsProject
= None) Constructor forQgsProcessingOutputLayerDefinition
, accepting aQgsProperty
sink/layer. ThedestinationProject
parameter can be set to aQgsProject
instance in which to automatically load the resulting sink/layer after completing processing.QgsProcessingOutputLayerDefinition(
QgsProcessingOutputLayerDefinition
)Methods
Loads this output layer definition from a QVariantMap, wrapped in a QVariant.
Returns the output remapping definition, if
useRemapping()
isTrue
.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
True
if the output uses a remapping definition.Attributes
-
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
New in version 3.2.
- Parameters
map (Dict[str) –
- Return type
bool
-
remappingDefinition
(self) → QgsRemappingSinkDefinition¶ Returns the output remapping definition, if
useRemapping()
isTrue
.See also
See also
New in version 3.14.
- Return type
-
setRemappingDefinition
(self, definition: QgsRemappingSinkDefinition)¶ Sets the remapping
definition
to use when adding features to the output layer.Calling this method will set
useRemapping()
toTrue
.See also
See also
New in version 3.14.
- Parameters
definition (QgsRemappingSinkDefinition) –
-
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
New in version 3.2.
- Return type
Any
-
useRemapping
(self) → bool¶ Returns
True
if the output uses a remapping definition.See also
New in version 3.14.
- Return type
bool
-