Class: QgsRasterLayerTemporalProperties

class qgis.core.QgsRasterLayerTemporalProperties

Bases: QgsMapLayerTemporalProperties

Implementation of map layer temporal properties for raster layers.

New in version 3.14.

QgsRasterLayerTemporalProperties(parent: QObject = None, enabled: bool = False) Constructor for QgsRasterLayerTemporalProperties, with the specified parent object.

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

Methods

allTemporalRanges

param layer

childEvent

connectNotify

customEvent

disconnectNotify

fixedTemporalRange

Returns the fixed temporal range for the layer.

flags

Returns flags associated to the temporal property.

intervalHandlingMethod

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

isSignalConnected

isVisibleInTemporalRange

param range

mode

Returns the temporal properties mode.

readXml

param element

receivers

sender

senderSignalIndex

setDefaultsFromDataProviderTemporalCapabilities

param capabilities

setFixedTemporalRange

Sets a temporal range to apply to the whole layer.

setIntervalHandlingMethod

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

setMode

Sets the temporal properties mode.

timerEvent

writeXml

param element

Attributes

ModeFixedTemporalRange

ModeTemporalRangeFromDataProvider

ModeFixedTemporalRange = 0
ModeTemporalRangeFromDataProvider = 1
class TemporalMode

Bases: int

allTemporalRanges(self, layer: QgsMapLayer)List[QgsDateTimeRange]
Parameters

layer (QgsMapLayer) –

Return type

List[QgsDateTimeRange]

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
fixedTemporalRange(self)QgsDateTimeRange

Returns the fixed temporal range for the layer.

Warning

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

Return type

QgsDateTimeRange

flags(self)QgsTemporalProperty.Flags

Returns flags associated to the temporal property.

Return type

QgsTemporalProperty.Flags

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(self, QMetaMethod)bool
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(self, PYQT_SIGNAL)int
sender(self)QObject
senderSignalIndex(self)int
setDefaultsFromDataProviderTemporalCapabilities(self, capabilities: QgsDataProviderTemporalCapabilities)
Parameters

capabilities (QgsDataProviderTemporalCapabilities) –

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) –

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

QDomElement