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 specifiedparent
object.The
enabled
argument specifies whether the temporal properties are initially enabled or not (seeisActive()
).Methods
- param layer
Returns the fixed temporal range for the layer.
Returns flags associated to the temporal property.
Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.
- param range
Returns the temporal properties mode.
- param element
- param capabilities
Sets a temporal
range
to apply to the whole layer.Sets the desired
method
to use when resolving a temporal interval to matching layers or bands in the data provider.Sets the temporal properties
mode
.- param element
Attributes
- 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.ModeFixedTemporalRangeSee also
- Return type
- flags(self) QgsTemporalProperty.Flags ¶
Returns flags associated to the temporal property.
- Return type
- intervalHandlingMethod(self) QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod ¶
Returns the desired method to use when resolving a temporal interval to matching layers or bands in the data provider.
See also
- 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
- Return type
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
- Parameters
element (QDomElement) –
context (QgsReadWriteContext) –
- 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 specifiedrange
.Warning
This setting is only effective when
mode()
is QgsRasterLayerTemporalProperties.ModeFixedTemporalRangeSee also
- 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.See also
- Parameters
method (QgsRasterDataProviderTemporalCapabilities.IntervalHandlingMethod) –
- setMode(self, mode: QgsRasterLayerTemporalProperties.TemporalMode)¶
Sets the temporal properties
mode
.See also
- Parameters
- timerEvent(self, QTimerEvent)¶
- writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
- Parameters
element (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement