Class: QgsMeshDatasetGroupMetadata¶
-
class
qgis.core.
QgsMeshDatasetGroupMetadata
¶ Bases:
sip.wrapper
Constructs an empty metadata object
QgsMeshDatasetGroupMetadata(name: str, isScalar: bool, isOnVertices: bool, minimum: float, maximum: float, extraOptions: Dict[str, str]) Constructs a valid metadata object
- Parameters
name – name of the dataset group
isScalar – dataset contains scalar data, specifically the y-value of QgsMeshDatasetValue is NaN
isOnVertices – dataset values are defined on mesh’s vertices. If
False
, values are defined on faces.minimum – minimum value (magnitude for vectors) present among all group’s dataset values
maximum – maximum value (magnitude for vectors) present among all group’s dataset values
extraOptions – dataset’s extra options stored by the provider. Usually contains the name, time value, time units, data file vendor, …
QgsMeshDatasetGroupMetadata(QgsMeshDatasetGroupMetadata)
QgsMeshDatasetGroupMetadata is a collection of dataset group metadata such as whether the data is vector or scalar, name
Note
The API is considered EXPERIMENTAL and can be changed without a notice
New in version 3.4: Enums
Methods
Returns whether dataset group data is defined on vertices or faces
Returns extra metadata options, for example description
Returns whether dataset group has scalar data
Returns whether dataset group has vector data
Returns maximum scalar value/vector magnitude present for whole dataset group
Returns minimum scalar value/vector magnitude present for whole dataset group
Returns name of the dataset group
Signals
Attributes
-
DataOnFaces
= 0¶
-
DataOnVertices
= 1¶
-
class
DataType
¶ Bases:
int
-
dataType
(self) → QgsMeshDatasetGroupMetadata.DataType¶ Returns whether dataset group data is defined on vertices or faces
-
extraOptions
(self) → Dict[str, str]¶ Returns extra metadata options, for example description
-
isScalar
(self) → bool¶ Returns whether dataset group has scalar data
-
isVector
(self) → bool¶ Returns whether dataset group has vector data
-
maximum
(self) → float¶ Returns maximum scalar value/vector magnitude present for whole dataset group
-
minimum
(self) → float¶ Returns minimum scalar value/vector magnitude present for whole dataset group
-
name
(self) → str¶ Returns name of the dataset group