Subgroup: Mesh

Class: QgsMeshDatasetMetadata

class qgis.core.QgsMeshDatasetMetadata

Bases: sip.wrapper

Constructs an empty metadata object

QgsMeshDatasetMetadata(isScalar: bool, isValid: bool, isOnVertices: bool, extraOptions: Dict[str, str]) Constructs a valid metadata object

Parameters:
  • isScalar – dataset contains scalar data, specifically the y-value of QgsMeshDatasetValue is NaN
  • isValid – dataset is loadad and valid for fetching the data
  • isOnVertices – dataset values are defined on mesh’s vertices. If false, values are defined on faces.
  • extraOptions – dataset’s extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, …

QgsMeshDatasetMetadata(QgsMeshDatasetMetadata)

QgsMeshDatasetMetadata is a collection of mesh dataset metadata such as whether the data is vector or scalar, etc.

Note

The API is considered EXPERIMENTAL and can be changed without a notice

New in version 3.2: Methods

extraOptions Returns extra metadata options Usually including name, description or time variable
isOnVertices Returns whether dataset data is defined on vertices
isScalar Returns whether dataset has scalar data
isValid Returns whether dataset is valid
isVector Returns whether dataset has vector data

Signals

Attributes

extraOptions(self) → Dict[str, str]

Returns extra metadata options Usually including name, description or time variable

isOnVertices(self) → bool

Returns whether dataset data is defined on vertices

isScalar(self) → bool

Returns whether dataset has scalar data

isValid(self) → bool

Returns whether dataset is valid

isVector(self) → bool

Returns whether dataset has vector data