Class: QgsProjectTimeSettings¶
- class qgis.core.QgsProjectTimeSettings(parent: QObject = None)¶
Bases:
PyQt5.QtCore.QObject
Constructor for
QgsProjectTimeSettings
with the specifiedparent
object.Contains temporal settings and properties for the project, this may be used when animating maps or showing temporal layers.
New in version 3.14:
Methods
Returns the project's default animation frame rate, in frames per second.
Returns the value of cumulative temporal range in animation settings.
Reads the settings's state from a DOM
element
.Resets the settings to a default state.
Sets the project's default animation frame
rate
, in frames per second.Sets the project's temporal range as cumulative in animation settings.
Sets the project's temporal
range
, which indicates the earliest and latest datetime ranges associated with the project.Sets the project's time
step
(length of one animation frame), which is used as the default value when animating the project.Sets the project's time step (length of one animation frame)
unit
, which is used as the default value when animating the project.Returns the project's temporal range, which indicates the earliest and latest datetime ranges associated with the project.
Returns the project's time step (length of one animation frame), which is used as the default value when animating the project.
Returns the project's time step (length of one animation frame) unit, which is used as the default value when animating the project.
Returns a DOM element representing the settings.
Signals
Emitted when the temporal range changes.
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- framesPerSecond(self) float ¶
Returns the project’s default animation frame rate, in frames per second.
See also
- Return type
float
- isSignalConnected(self, QMetaMethod) bool ¶
- isTemporalRangeCumulative(self) bool ¶
Returns the value of cumulative temporal range in animation settings.
See also
- Return type
bool
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
Reads the settings’s state from a DOM
element
.See also
- Parameters
element (QDomElement) –
context (QgsReadWriteContext) –
- Return type
bool
- receivers(self, PYQT_SIGNAL) int ¶
- reset(self)¶
Resets the settings to a default state.
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setFramesPerSecond(self, rate: float)¶
Sets the project’s default animation frame
rate
, in frames per second.See also
- Parameters
rate (float) –
- setIsTemporalRangeCumulative(self, state: bool)¶
Sets the project’s temporal range as cumulative in animation settings.
See also
- Parameters
state (bool) –
- setTemporalRange(self, range: QgsDateTimeRange)¶
Sets the project’s temporal
range
, which indicates the earliest and latest datetime ranges associated with the project.Note
This is a manual, use-set property, and does not necessarily coincide with the earliest and latest temporal ranges set for individual layers in the project.
See also
See also
- Parameters
range (QgsDateTimeRange) –
- setTimeStep(self, step: float)¶
Sets the project’s time
step
(length of one animation frame), which is used as the default value when animating the project.Units are specified via
setTimeStepUnit()
See also
See also
- Parameters
step (float) –
- setTimeStepUnit(self, unit: QgsUnitTypes.TemporalUnit)¶
Sets the project’s time step (length of one animation frame)
unit
, which is used as the default value when animating the project.See also
See also
- Parameters
unit (QgsUnitTypes.TemporalUnit) –
- temporalRange(self) QgsDateTimeRange ¶
Returns the project’s temporal range, which indicates the earliest and latest datetime ranges associated with the project.
Note
This is a manual, use-set property, and does not necessarily coincide with the earliest and latest temporal ranges set for individual layers in the project.
See also
See also
- Return type
- temporalRangeChanged¶
Emitted when the temporal range changes.
See also
See also
setTemporalRange()
[signal]
- timeStep(self) float ¶
Returns the project’s time step (length of one animation frame), which is used as the default value when animating the project.
Units are specified via
timeStepUnit()
See also
See also
- Return type
float
- timeStepUnit(self) QgsUnitTypes.TemporalUnit ¶
Returns the project’s time step (length of one animation frame) unit, which is used as the default value when animating the project.
See also
See also
- Return type
- timerEvent(self, QTimerEvent)¶
- writeXml(self, document: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
Returns a DOM element representing the settings.
See also
- Parameters
document (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement