Class: QgsMeshDatasetGroupMetadata¶
-
class
qgis.core.
QgsMeshDatasetGroupMetadata
¶ Bases:
sip.wrapper
Constructs an empty metadata object
QgsMeshDatasetGroupMetadata(name: str, isScalar: bool, isOnVertices: bool, 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 NaNisOnVertices – 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, …
QgsMeshDatasetGroupMetadata(
QgsMeshDatasetGroupMetadata
)QgsMeshDatasetGroupMetadata
is a collection of dataset group metadata such as whether the data is vector or scalar, nameNote
The API is considered EXPERIMENTAL and can be changed without a notice
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 name of the dataset group
Attributes
-
DataOnFaces
= 0¶
-
DataOnVertices
= 1¶
-
class
DataType
¶ Bases:
int
-
dataType
(self) → QgsMeshDatasetGroupMetadata.DataType¶ Returns whether dataset group data is defined on vertices or faces
- Return type
-
extraOptions
(self) → Dict[str, str]¶ Returns extra metadata options, for example description
- Return type
Dict[str, str]
-
isScalar
(self) → bool¶ Returns whether dataset group has scalar data
- Return type
bool
-
isVector
(self) → bool¶ Returns whether dataset group has vector data
- Return type
bool
-
name
(self) → str¶ Returns name of the dataset group
- Return type
str