Class: QgsVectorLayerExporterTask¶
-
class
qgis.core.
QgsVectorLayerExporterTask
(layer: QgsVectorLayer, uri: str, providerKey: str, destinationCrs: QgsCoordinateReferenceSystem, options: Dict[str, Any] = {}, ownsLayer: bool = False)¶ Bases:
QgsTask
Constructor for
QgsVectorLayerExporterTask
. Takes a sourcelayer
, destinationuri
andproviderKey
, and various export related parameters such as destination CRS and exportoptions
.ownsLayer
has to be set toTrue
if the task should take ownership of the layer and delete it after export.QgsTask
task which performs aQgsVectorLayerExporter
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.
- Parameters
layer (QgsVectorLayer) –
uri (str) –
providerKey (str) –
destinationCrs (QgsCoordinateReferenceSystem) –
options (Dict[str) –
ownsLayer –
-
cancel
(self)¶
-
childEvent
(self, QChildEvent)¶
-
connectNotify
(self, QMetaMethod)¶
-
customEvent
(self, QEvent)¶
-
disconnectNotify
(self, QMetaMethod)¶
-
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]- Parameters
error (int) –
errorMessage (str) –
-
exportComplete
¶ Emitted when exporting the layer is successfully completed. [signal]
-
finished
(self, result: bool)¶ - Parameters
result (bool) –
-
isCanceled
(self) → bool¶ Will return
True
if task should terminate ASAP. If the task reports the CanCancel flag, then derived classes’ run() methods should periodically check this and terminate in a safe manner.
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
receivers
(self, PYQT_SIGNAL) → int¶
-
run
(self) → bool¶ - Return type
bool
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setProgress
(self, progress: float)¶ Sets the task’s current progress. The derived class should call this method whenever the task wants to update its progress. Calling will automatically emit the progressChanged signal.
- Parameters
progress – percent of progress, from 0.0 - 100.0
-
timerEvent
(self, QTimerEvent)¶
-
withLayerOwnership
(layer: QgsVectorLayer, uri: str, providerKey: str, destinationCrs: QgsCoordinateReferenceSystem, options: Dict[str, Any] = {}) → QgsVectorLayerExporterTask¶ Creates a new
QgsVectorLayerExporterTask
which has ownership over a sourcelayer
. 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.- Parameters
layer (QgsVectorLayer) –
uri (str) –
providerKey (str) –
destinationCrs (QgsCoordinateReferenceSystem) –
options (Dict[str) –
- Return type