Class: QgsMapLayerTemporalProperties¶

Base class for storage of map layer temporal properties.

QgsMapLayerTemporalProperties exposes user-configurable settings for controlling how an individual QgsMapLayer behaves in a temporal context, e.g. while animating a map object.

Added in version 3.14.

Class Hierarchy¶

Base classes¶

`QgsTemporalProperty`	Base class for temporal property.
QObject

Subclasses¶

`QgsMeshLayerTemporalProperties`	Implementation of map layer temporal properties for mesh layers.
`QgsRasterLayerTemporalProperties`	Implementation of map layer temporal properties for raster layers.
`QgsVectorLayerTemporalProperties`	Implementation of map layer temporal properties for vector layers.

Methods

`allTemporalRanges`	Attempts to calculate the overall list of all temporal extents which are contained in the specified layer, using the settings defined by the temporal properties object.
`isVisibleInTemporalRange`	Returns `True` if the layer should be visible and rendered for the specified time range.
`readXml`	Reads temporal properties from a DOM element previously written by `writeXml()`.
`setDefaultsFromDataProviderTemporalCapabilities`	Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities.
`writeXml`	Writes the properties to a DOM element, to be used later with `readXml()`.

class qgis.core.QgsMapLayerTemporalProperties[source]¶

Bases: QgsTemporalProperty

__init__(parent: QObject | None, enabled: bool = False)

Constructor for QgsMapLayerTemporalProperties, with the specified parent object.

The enabled argument specifies whether the temporal properties are initially enabled or not (see isActive()).

Parameters:

parent (Optional[QObject])
enabled (bool = False)

allTemporalRanges(self, layer: QgsMapLayer | None) → List[QgsDateTimeRange]¶

Attempts to calculate the overall list of all temporal extents which are contained in the specified layer, using the settings defined by the temporal properties object.

May return an empty list if the ranges could not be calculated.

Added in version 3.20.

Parameters:: layer (Optional[QgsMapLayer])
Return type:: List[QgsDateTimeRange]

isVisibleInTemporalRange(self, range: QgsDateTimeRange) → bool[source]¶

Returns True if the layer should be visible and rendered for the specified time range.

Parameters:: range (QgsDateTimeRange)
Return type:: bool

readXml(self, element: QDomElement, context: QgsReadWriteContext) → bool[source]¶

Reads temporal properties from a DOM element previously written by writeXml().