Class: QgsRasterLayerTemporalProperties

class qgis.core.QgsRasterLayerTemporalProperties(parent: QObject = None, enabled: bool = False)

Bases: QgsMapLayerTemporalProperties

Constructor for QgsRasterLayerTemporalProperties, with the specified parent object.

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

Implementation of map layer temporal properties for raster layers.

New in version 3.14.

Parameters
  • parent (QObject = None) –

  • enabled

ModeFixedTemporalRange = 0
ModeTemporalRangeFromDataProvider = 1
class TemporalMode

Bases: int

childEvent()
connectNotify()
customEvent()
disconnectNotify()
fixedReferenceTemporalRange(self)QgsDateTimeRange

Returns the fixed reference temporal range for the layer.

Warning

To be used only when mode() is QgsRasterLayerTemporalProperties.ModeFixedTemporalRange

Return type

QgsDateTimeRange

fixedTemporalRange(self)QgsDateTimeRange

Returns the fixed temporal range for the layer.

Warning

To be used only when mode() is QgsRasterLayerTemporalProperties.ModeFixedTemporalRange

Return type

QgsDateTimeRange

intervalHandlingMethod(self) → QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod

Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.

Return type

QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod

isSignalConnected()
isVisibleInTemporalRange(self, range: QgsDateTimeRange) → bool
Parameters

range (QgsDateTimeRange) –

Return type

bool

mode(self) → QgsRasterLayerTemporalProperties.TemporalMode

Returns the temporal properties mode.

See also

setMode()

Return type

QgsRasterLayerTemporalProperties.TemporalMode

readXml(self, element: QDomElement, context: QgsReadWriteContext) → bool
Parameters
Return type

bool

receivers()
referenceTemporalRange(self)QgsDateTimeRange

Returns the current active reference datetime range for these temporal properties.

Return type

QgsDateTimeRange

sender()
senderSignalIndex()
setDefaultsFromDataProviderTemporalCapabilities(self, capabilities: QgsDataProviderTemporalCapabilities)
Parameters

capabilities (QgsDataProviderTemporalCapabilities) –

setFixedReferenceTemporalRange(self, range: QgsDateTimeRange)

Sets a fixed reference temporal range to apply to the whole layer. All bands from the raster layer will be rendered whenever the current datetime range of a render context intersects the specified range.

Warning

This setting is only effective when mode() is QgsRasterLayerTemporalProperties.ModeFixedTemporalRange

Parameters

range (QgsDateTimeRange) –

setFixedTemporalRange(self, range: QgsDateTimeRange)

Sets a temporal range to apply to the whole layer. All bands from the raster layer will be rendered whenever the current datetime range of a render context intersects the specified range.

Warning

This setting is only effective when mode() is QgsRasterLayerTemporalProperties.ModeFixedTemporalRange

Parameters

range (QgsDateTimeRange) –

setIntervalHandlingMethod(self, method: QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod)

Sets the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.

Parameters

method (QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod) –

setMode(self, mode: QgsRasterLayerTemporalProperties.TemporalMode)

Sets the temporal properties mode.

See also

mode()

Parameters

mode (QgsRasterLayerTemporalProperties.TemporalMode) –

setReferenceTemporalRange(self, dateTimeRange: QgsDateTimeRange)

Sets the current active reference datetime range for the temporal properties.

This will be used by bi-temporal data.

Note

This can be set by user, through raster layer properties widget.

Parameters

dateTimeRange (QgsDateTimeRange) –

setTemporalRange(self, dateTimeRange: QgsDateTimeRange)

Sets the current active datetime range for the temporal properties.

Note

This can be set by user, through raster layer properties widget.

See also

temporalRange()

Parameters

dateTimeRange (QgsDateTimeRange) –

temporalRange(self)QgsDateTimeRange

Returns the current active datetime range for these temporal properties.

Return type

QgsDateTimeRange

timerEvent()
writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement
Parameters
Return type

QDomElement