Class: QgsTemporalRangeObject¶
Base class for objects with an associated (optional) temporal range.
Added in version 3.14.
Class Hierarchy¶
Subclasses¶
Layout graphical items for displaying a map.  | 
|
The   | 
|
Contains information about the context of a rendering operation.  | 
|
Definition of the world.  | 
|
Implements support of 3D map views in print layouts  | 
Methods
Returns   | 
|
Sets whether the temporal range is enabled (i.e. whether the object has a temporal range which will be considered when rendering maps with a specific time range set.).  | 
|
Sets the temporal range for the object.  | 
|
Returns the datetime range for the object.  | 
- class qgis.core.QgsTemporalRangeObject[source]¶
 Bases:
object- __init__(enabled: bool = False)
 Constructor QgsTemporalRangeObject.
The
enabledargument specifies whether the temporal range is initially enabled or not (seeisTemporal()).- Parameters:
 enabled (bool = False)
- __init__(a0: QgsTemporalRangeObject)
 - Parameters:
 
- isTemporal(self) bool[source]¶
 Returns
Trueif the object’s temporal range is enabled, and the object will be filtered when rendering maps with a specific time range set.For map settings, if
Falseis returned, then any other temporal settings relating to the map will be ignored during rendering.See also
- Return type:
 bool
- setIsTemporal(self, enabled: bool)[source]¶
 Sets whether the temporal range is
enabled(i.e. whether the object has a temporal range which will be considered when rendering maps with a specific time range set.)See also
- Parameters:
 enabled (bool)
- setTemporalRange(self, range: QgsDateTimeRange)[source]¶
 Sets the temporal
rangefor the object.Calling
setTemporalRange()automatically enables temporal properties on the object (seeisTemporal()), regardless of its existing state.When a temporal
rangeis set it can be used to filter and request time base objects.See also
- Parameters:
 range (QgsDateTimeRange)
- temporalRange(self) QgsDateTimeRange¶
 Returns the datetime range for the object.
This should only be considered when
isTemporal()returnsTrue.See also
- Return type: