Class: QgsMapLayerTemporalProperties¶
- class qgis.core.QgsMapLayerTemporalProperties(parent: QObject, enabled: bool = False)¶
Bases:
QgsTemporalProperty
Constructor for
QgsMapLayerTemporalProperties
, with the specifiedparent
object.The
enabled
argument specifies whether the temporal properties are initially enabled or not (seeisActive()
).Base class for storage of map layer temporal properties.
QgsMapLayerTemporalProperties
exposes user-configurable settings for controlling how an individualQgsMapLayer
behaves in a temporal context, e.g. while animating a map object.New in version 3.14:
Methods
Returns
True
if the layer should be visible and rendered for the specified timerange
.Reads temporal properties from a DOM
element
previously written bywriteXml()
.Sets the layers temporal settings to appropriate defaults based on a provider's temporal
capabilities
.Writes the properties to a DOM
element
, to be used later withreadXml()
.- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- isVisibleInTemporalRange(self, range: QgsDateTimeRange) bool ¶
Returns
True
if the layer should be visible and rendered for the specified timerange
.- Parameters
range (QgsDateTimeRange) –
- Return type
bool
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
Reads temporal properties from a DOM
element
previously written bywriteXml()
.See also
- Parameters
element (QDomElement) –
context (QgsReadWriteContext) –
- Return type
bool
- receivers(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setDefaultsFromDataProviderTemporalCapabilities(self, capabilities: QgsDataProviderTemporalCapabilities)¶
Sets the layers temporal settings to appropriate defaults based on a provider’s temporal
capabilities
.- Parameters
capabilities (QgsDataProviderTemporalCapabilities) –
- timerEvent(self, QTimerEvent)¶
- writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
Writes the properties to a DOM
element
, to be used later withreadXml()
.See also
- Parameters
element (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement