Class: QgsOfflineEditing

class qgis.core.QgsOfflineEditing

Bases: PyQt5.QtCore.QObject

Methods

childEvent

connectNotify

convertToOfflineProject

Convert current project for offline editing

customEvent

disconnectNotify

isOfflineProject

Returns True if current project is offline

isSignalConnected

receivers

sender

senderSignalIndex

synchronize

Synchronize to remote layers

timerEvent

Signals

layerProgressUpdated

Emitted whenever a new layer is being processed.

progressModeSet

Emitted when the mode for the progress of the current operation is set.

progressStarted

Emitted when the process has started.

progressStopped

Emitted when the processing of all layers has finished [signal]

progressUpdated

Emitted with the progress of the current mode

warning

Emitted when a warning needs to be displayed.

Attributes

AddFeatures

AddFields

CopyFeatures

GPKG

ProcessFeatures

RemoveFeatures

SpatiaLite

UpdateFeatures

UpdateGeometries

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 (str) – Path to offline db file

  • offlineDbFile (str) – Offline db file name

  • layerIds (Iterable[str]) – List of layer names to convert

  • onlySelected (bool = False) – Only copy selected features from layers where a selection is present

  • containerType (QgsOfflineEditing.ContainerType = QgsOfflineEditing.SpatiaLite) – defines the SQLite file container type like SpatiaLite or GPKG

Return type

bool

customEvent()
disconnectNotify()
isOfflineProject(self) → bool

Returns True if current project is offline

Return type

bool

isSignalConnected()
layerProgressUpdated

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 amount numLayers. [signal]

Parameters
  • layer (int) –

  • numLayers (int) –

progressModeSet

Emitted when the mode for the progress of the current operation is set.

Parameters
progressStarted

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 (int) – 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 (str) – title string for message

  • message (str) – A descriptive message for the warning [signal]