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

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

progressStarted

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

progressStopped

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

warning

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

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(self, QChildEvent)
connectNotify(self, QMetaMethod)
convertToOfflineProject(self, offlineDataPath: str, offlineDbFile: str, layerIds: Iterable[str], onlySelected: bool = False, containerType: QgsOfflineEditing.ContainerType = QgsOfflineEditing.SpatiaLite, layerNameSuffix: str = '') 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

  • layerNameSuffix (str = '') – Suffix string added to the offline layer name

Return type

bool

customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
isOfflineProject(self) bool

Returns True if current project is offline

Return type

bool

isSignalConnected(self, QMetaMethod) bool
layerProgressUpdated

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

progressStarted

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

progressStopped

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type

PYQT_SIGNAL

receivers(self, PYQT_SIGNAL) int
sender(self) QObject
senderSignalIndex(self) int
synchronize(self, useTransaction: bool = False)

Synchronize to remote layers

Parameters

useTransaction (bool = False) – enforce the remote layer modifications with the same source to be in a transaction group

timerEvent(self, QTimerEvent)
warning

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type

PYQT_SIGNAL