Class: QgsMeshLayerTemporalProperties

class qgis.core.QgsMeshLayerTemporalProperties

Bases: QgsMapLayerTemporalProperties

Implementation of map layer temporal properties for mesh layers.

The time in a mesh layer is defined by :

  • a reference time provided by the data, the project or the user

  • each dataset is associated with a relative times

  • time extent is defined by the first time and the last time of all dataset

Reference time :          AT
Dataset 1 time            o-----RT------RT-----RT-----------RT
Dataset 2 time            o---------RT------RT--------RT
Dataset 3 time            o------------------------------RT-------RT----------RT
Time extent of layer      o-----<--------------------------------------------->

AT : absolute time (QDateTime)
RT : relative time (qint64)

New in version 3.14.

QgsMeshLayerTemporalProperties(parent: QObject = None, enabled: bool = True) Constructor for QgsMeshLayerTemporalProperties

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
isSignalConnected(self, QMetaMethod) bool
isValid(self) bool

Returns whether the instance is valid

New in version 3.22.

Return type


matchingMethod(self) QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod

Returns the method used to match dataset from temporal capabilities

Return type


readXml(self, element: QDomElement, context: QgsReadWriteContext) bool
Return type


receivers(self, PYQT_SIGNAL) int
referenceTime(self) QDateTime

Returns the reference time

Return type


sender(self) QObject
senderSignalIndex(self) int
setDefaultsFromDataProviderTemporalCapabilities(self, capabilities: QgsDataProviderTemporalCapabilities)

capabilities (QgsDataProviderTemporalCapabilities) –

setIsValid(self, isValid: bool)

Sets whether the instance is valid


isValid (bool) – whether the instance is valid

New in version 3.22.

setMatchingMethod(self, matchingMethod: QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod)

Sets the method used to match dataset from temporal capabilities


matchingMethod (QgsMeshDataProviderTemporalCapabilities.MatchingTemporalDatasetMethod) – the matching method

setReferenceTime(self, referenceTime: Union[QDateTime, datetime.datetime], capabilities: QgsDataProviderTemporalCapabilities)

Sets the reference time and update the time extent from the temporal capabilities, if the temporal capabilities is null, set a void time extent (reference time to reference time)

timeExtent(self) QgsDateTimeRange

Returns the time extent

Return type


timerEvent(self, QTimerEvent)
writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) QDomElement
Return type