Class: QgsVectorDataProviderTemporalCapabilities

Implementation of data provider temporal properties for QgsVectorDataProviders.

Data provider temporal capabilities reflect the temporal capabilities of a QgsDataProvider. Unlike QgsMapLayerTemporalProperties, these settings are not user-configurable, and should only be set by the QgsDataProvider itself.

Added in version 3.14.

Class Hierarchy

Base classes

QgsDataProviderTemporalCapabilities

Base class for handling properties relating to a data provider’s temporal capabilities.

Enums

TemporalMode

alias of VectorDataProviderTemporalMode

Methods

availableTemporalRange	Returns the datetime range extent from which temporal data is available from the provider.
endField	Returns the name of the end datetime field, which stores the end time for the feature's time spans.
mode	Returns the temporal properties mode.
setAvailableTemporalRange	Sets the datetime range extent from which temporal data is available from the provider.
setEndField	Sets the name of the end datetime field, which stores the end time for the feature's time spans.
setMode	Sets the temporal properties mode.
setStartField	Sets the name of the start datetime field, which stores the start time for the feature's time spans.
startField	Returns the name of the start datetime field, which contains the start time for the feature's time spans.

class qgis.core.QgsVectorDataProviderTemporalCapabilities

Bases: QgsDataProviderTemporalCapabilities

__init__(enabled: bool = False)

Constructor for QgsVectorDataProviderTemporalCapabilities.

The enabled argument specifies whether the data provider has temporal capabilities.

Parameters:

enabled (bool = False)

__init__(a0: QgsVectorDataProviderTemporalCapabilities)

Parameters:

a0 (QgsVectorDataProviderTemporalCapabilities)

TemporalMode

alias of VectorDataProviderTemporalMode

availableTemporalRange(self) → QgsDateTimeRange

Returns the datetime range extent from which temporal data is available from the provider.

See also

setAvailableTemporalRange()

Return type:

QgsDateTimeRange

endField(self) → str

Returns the name of the end datetime field, which stores the end time for the feature’s time spans.

See also

setEndField()

See also

startField()

Return type:

str

mode(self) → Qgis.VectorDataProviderTemporalMode

Returns the temporal properties mode.

See also

setMode()

Return type:

Qgis.VectorDataProviderTemporalMode

setAvailableTemporalRange(self, range: QgsDateTimeRange)

Sets the datetime range extent from which temporal data is available from the provider.

See also

availableTemporalRange()

Parameters:

range (QgsDateTimeRange)

setEndField(self, field: str | None)

Sets the name of the end datetime field, which stores the end time for the feature’s time spans.

See also

endField()

See also

setStartField()

Parameters:

field (Optional[str])

setMode(self, mode: Qgis.VectorDataProviderTemporalMode)

Sets the temporal properties mode.

See also

mode()

Parameters:

mode (Qgis.VectorDataProviderTemporalMode)

setStartField(self, field: str | None)

Sets the name of the start datetime field, which stores the start time for the feature’s time spans.

If mode() is ModeFeatureDateTimeInstantFromField, then this field stores both the start AND end times.

See also

startField()

See also

setEndField()

Parameters:

field (Optional[str])

startField(self) → str

Returns the name of the start datetime field, which contains the start time for the feature’s time spans.

If mode() is ProviderStoresFeatureDateTimeInstantInField, then this field stores both the start AND end times.

See also

setStartField()

See also

endField()

Return type:

str