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()).

Enums

TemporalMode

alias of RasterTemporalMode

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:

TemporalMode

alias of RasterTemporalMode

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) Qgis.TemporalIntervalMatchMethod

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

Return type:

Qgis.TemporalIntervalMatchMethod

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

range (QgsDateTimeRange) –

Return type:

bool

mode(self) Qgis.RasterTemporalMode

Returns the temporal properties mode.

See also

setMode()

Return type:

Qgis.RasterTemporalMode

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: Qgis.TemporalIntervalMatchMethod)

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

Parameters:

method (Qgis.TemporalIntervalMatchMethod) –

setMode(self, mode: Qgis.RasterTemporalMode)

Sets the temporal properties mode.

See also

mode()

Parameters:

mode (Qgis.RasterTemporalMode) –

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

QDomElement