Class: QgsProjectTimeSettings

class qgis.core.QgsProjectTimeSettings(parent: QObject = None)

Bases: PyQt5.QtCore.QObject

Constructor for QgsProjectTimeSettings with the specified parent 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.

Parameters

parent

childEvent()
connectNotify()
customEvent()
disconnectNotify()
framesPerSecond(self) → float

Returns the project’s default animation frame rate, in frames per second.

Return type

float

isSignalConnected()
readXml(self, element: QDomElement, context: QgsReadWriteContext) → bool

Reads the settings’s state from a DOM element.

See also

writeXml()

Parameters
Return type

bool

receivers()
reset(self)

Resets the settings to a default state.

sender()
senderSignalIndex()
setFramesPerSecond(self, rate: float)

Sets the project’s default animation frame rate, in frames per second.

Parameters

rate (float) –

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

temporalRange()

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

timeStep()

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

timeStepUnit()

See also

setTimeStep()

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.

Return type

QgsDateTimeRange

temporalRangeChanged

Emitted when the temporal range changes.

See also

temporalRange()

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

setTimeStep()

See also

timeStepUnit()

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

timeStep()

Return type

QgsUnitTypes.TemporalUnit

timerEvent()
writeXml(self, document: QDomDocument, context: QgsReadWriteContext) → QDomElement

Returns a DOM element representing the settings.

See also

readXml()

Parameters
Return type

QDomElement