Class: QgsOfflineEditing¶
-
class
qgis.core.
QgsOfflineEditing
¶ Bases:
PyQt5.QtCore.QObject
Enums
Methods
Convert current project for offline editing
Returns true if current project is offline
Synchronize to remote layers
Signals
Is emitted whenever a new layer is being processed.
Is emitted when the mode for the progress of the current operation is set.
The signal is emitted when the process has started.
Emitted when the processing of all layers has finished [signal]
Emitted with the progress of the current mode
Emitted when a warning needs to be displayed.
Attributes
-
AddFeatures
= 3¶
-
AddFields
= 2¶
-
class
ContainerType
¶ Bases:
int
-
CopyFeatures
= 0¶
-
GPKG
= 1¶
-
ProcessFeatures
= 1¶
-
class
ProgressMode
¶ Bases:
int
-
RemoveFeatures
= 4¶
-
SpatiaLite
= 0¶
-
UpdateFeatures
= 5¶
-
UpdateGeometries
= 6¶
-
childEvent
()¶
-
connectNotify
()¶
-
convertToOfflineProject
(self, offlineDataPath: str, offlineDbFile: str, layerIds: Iterable[str], onlySelected: bool = False, containerType: QgsOfflineEditing.ContainerType = QgsOfflineEditing.SpatiaLite) → bool¶ Convert current project for offline editing
- Parameters
offlineDataPath – Path to offline db file
offlineDbFile – Offline db file name
layerIds – List of layer names to convert
onlySelected – Only copy selected features from layers where a selection is present
containerType – defines the SQLite file container type like SpatiaLite or GPKG
-
customEvent
()¶
-
disconnectNotify
()¶
-
isOfflineProject
(self) → bool¶ Returns true if current project is offline
-
isSignalConnected
()¶
-
layerProgressUpdated
¶ Is emitted whenever a new layer is being processed. It is possible to estimate the progress of the complete operation by comparing the index of the current
layer
to the total amountnumLayers
. [signal]
-
progressModeSet
¶ Is emitted when the mode for the progress of the current operation is set.
- Parameters
mode – progress mode
maximum – total number of entities to process in the current operation [signal]
-
progressStarted
¶ The signal is emitted when the process has started. [signal]
-
progressStopped
¶ Emitted when the processing of all layers has finished [signal]
-
progressUpdated
¶ Emitted with the progress of the current mode
- Parameters
progress – current index of processed entities [signal]
-
receivers
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
synchronize
(self)¶ Synchronize to remote layers
-
timerEvent
()¶
-
warning
¶ Emitted when a warning needs to be displayed.
- Parameters
title – title string for message
message – A descriptive message for the warning [signal]
-