Class: QgsMeshTimeSettings

class qgis.core.QgsMeshTimeSettings

Bases: sip.wrapper

Default constructor for relative time formate and 0 offset

QgsMeshTimeSettings(relativeTimeOffsetHours: float, relativeTimeFormat: str) Constructs relative time format settings with defined offset in hours

QgsMeshTimeSettings(absoluteTimeReferenceTime: Union[QDateTime, datetime.datetime], absoluteTimeFormat: str) Constructs absolute time format settings with defined reference time

QgsMeshTimeSettings(QgsMeshTimeSettings)

Represents a mesh time settings for mesh datasets

New in version 3.8: Enums

Methods

absoluteTimeFormat	Returns format used for absolute time
absoluteTimeReferenceTime	Returns reference time used for absolute time format
readXml	Reads configuration from the given DOM element
relativeTimeFormat	Returns format used for relative time
relativeTimeOffsetHours	Returns number of offset hours for relative time formatting
setAbsoluteTimeFormat	Sets format used for absolute time
setAbsoluteTimeReferenceTime	Sets reference time used for absolute time format
setRelativeTimeFormat	Sets format used for relative time
setRelativeTimeOffsetHours	Sets number of offset hours for relative time formatting
setUseAbsoluteTime	Sets use absolute time flag
useAbsoluteTime	Returns whether to use absolute time format
writeXml	Writes configuration to a new DOM element

Signals

Attributes

absoluteTimeFormat(self) → str

Returns format used for absolute time

absoluteTimeReferenceTime(self) → QDateTime

Returns reference time used for absolute time format

readXml(self, elem: QDomElement, context: QgsReadWriteContext)

Reads configuration from the given DOM element

relativeTimeFormat(self) → str

Returns format used for relative time

relativeTimeOffsetHours(self) → float

Returns number of offset hours for relative time formatting

setAbsoluteTimeFormat(self, absoluteTimeFormat: str)

Sets format used for absolute time

setAbsoluteTimeReferenceTime(self, absoluteTimeReferenceTime: Union[QDateTime, datetime.datetime])

Sets reference time used for absolute time format

setRelativeTimeFormat(self, relativeTimeFormat: str)

Sets format used for relative time

setRelativeTimeOffsetHours(self, relativeTimeOffsetHours: float)

Sets number of offset hours for relative time formatting

setUseAbsoluteTime(self, useAbsoluteTime: bool)

Sets use absolute time flag

useAbsoluteTime(self) → bool

Returns whether to use absolute time format

writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement

Writes configuration to a new DOM element