Subgroup: Vector
Class: QgsVectorLayerExporterTask¶
-
class
qgis.core.
QgsVectorLayerExporterTask
(layer: QgsVectorLayer, uri: str, providerKey: str, destinationCrs: QgsCoordinateReferenceSystem, options: Dict[str, Any] = {}, ownsLayer: bool = False)¶ Bases:
qgis._core.QgsTask
Constructor for QgsVectorLayerExporterTask. Takes a source
layer
, destinationuri
andproviderKey
, and various export related parameters such as destination CRS and exportoptions
.ownsLayer
has to be set to true if the task should take ownership of the layer and delete it after export.QgsTask task which performs a QgsVectorLayerExporter layer export operation as a background task. This can be used to export a vector layer out to a provider without blocking the QGIS interface.
See also
See also
New in version 3.0: Methods
cancel
childEvent
connectNotify
customEvent
disconnectNotify
finished
isCanceled
isSignalConnected
receivers
run
sender
senderSignalIndex
setProgress
timerEvent
withLayerOwnership
Creates a new QgsVectorLayerExporterTask which has ownership over a source layer
.Signals
errorOccurred
Emitted when an error occurs which prevented the layer being exported (or if the task is canceled). exportComplete
Emitted when exporting the layer is successfully completed. Attributes
-
cancel
(self)¶
-
childEvent
()¶
-
connectNotify
()¶
-
customEvent
()¶
-
disconnectNotify
()¶
-
errorOccurred
¶ Emitted when an error occurs which prevented the layer being exported (or if the task is canceled). The export
error
anderrorMessage
will be reported. [signal]
-
exportComplete
¶ Emitted when exporting the layer is successfully completed. [signal]
-
finished
(self, result: bool)¶
-
isCanceled
()¶
-
isSignalConnected
()¶
-
receivers
()¶
-
run
(self) → bool¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setProgress
()¶
-
timerEvent
()¶
-
withLayerOwnership
(layer: QgsVectorLayer, uri: str, providerKey: str, destinationCrs: QgsCoordinateReferenceSystem, options: Dict[str, Any] = {}) → QgsVectorLayerExporterTask¶ Creates a new QgsVectorLayerExporterTask which has ownership over a source
layer
. When the export task has completed (successfully or otherwise)layer
will be deleted. The destinationuri
andproviderKey
, and various export related parameters such as destination CRS and exportoptions
must be specified.
-