Class: QgsVectorFileWriterTask¶
-
class
qgis.core.
QgsVectorFileWriterTask
(layer: QgsVectorLayer, fileName: str, options: QgsVectorFileWriter.SaveVectorOptions)¶ Bases:
QgsTask
Constructor for
QgsVectorFileWriterTask
. Takes a sourcelayer
, destinationfileName
and saveoptions
.QgsTask
task which performs aQgsVectorFileWriter
layer saving operation as a background task. This can be used to save a vector layer out to a file without blocking the QGIS interface.See also
See also
New in version 3.0.
- Parameters
layer (QgsVectorLayer) –
fileName (str) –
options –
-
cancel
(self)¶
-
childEvent
()¶
-
connectNotify
()¶
-
customEvent
()¶
-
disconnectNotify
()¶
-
errorOccurred
¶ Emitted when an error occurs which prevented the file being written (or if the task is canceled). The writing
error
anderrorMessage
will be reported. [signal]
-
finished
(self, result: bool)¶ - Parameters
result (bool) –
-
isCanceled
()¶
-
isSignalConnected
()¶
-
receivers
()¶
-
run
(self) → bool¶ - Return type
bool
-
sender
()¶
-
senderSignalIndex
()¶
-
setProgress
()¶
-
timerEvent
()¶
-
writeComplete
¶ Emitted when writing the layer is successfully completed. The
newFilename
parameter indicates the file path for the written file.Note
this signal is deprecated in favor of completed(). [signal]