Class: QgsMeshRendererScalarSettings¶
- class qgis.core.QgsMeshRendererScalarSettings¶
Bases:
sip.wrapper
Represents a mesh renderer settings for scalar datasets
Note
The API is considered EXPERIMENTAL and can be changed without a notice
New in version 3.2:
Methods
Returns max value used for creation of the color ramp shader
Returns min value used for creation of the color ramp shader
Returns color ramp shader function
Returns the type of interpolation to use to convert face defined datasets to values on vertices
Returns the stroke width used to render edges scalar dataset
Returns the stroke width unit used to render edges scalar dataset
Returns opacity
Reads configuration from the given DOM element
Sets min/max values used for creation of the color ramp shader
Sets color ramp shader function
Sets data interpolation method
Sets the stroke width used to render edges scalar dataset
Sets the stroke width unit used to render edges scalar dataset
Sets opacity
Writes configuration to a new DOM element
Attributes
- class DataResamplingMethod¶
Bases:
int
- NeighbourAverage = 1¶
- None = 0¶
- classificationMaximum(self) float ¶
Returns max value used for creation of the color ramp shader
- Return type:
float
- classificationMinimum(self) float ¶
Returns min value used for creation of the color ramp shader
- Return type:
float
- colorRampShader(self) QgsColorRampShader ¶
Returns color ramp shader function
- Return type:
- dataResamplingMethod(self) QgsMeshRendererScalarSettings.DataResamplingMethod ¶
Returns the type of interpolation to use to convert face defined datasets to values on vertices
New in version 3.12.
- Return type:
- edgeStrokeWidth(self) QgsInterpolatedLineWidth ¶
Returns the stroke width used to render edges scalar dataset
New in version 3.14.
- Return type:
- edgeStrokeWidthUnit(self) QgsUnitTypes.RenderUnit ¶
Returns the stroke width unit used to render edges scalar dataset
New in version 3.14.
- Return type:
- opacity(self) float ¶
Returns opacity
- Return type:
float
- readXml(self, elem: QDomElement, context: QgsReadWriteContext = QgsReadWriteContext())¶
Reads configuration from the given DOM element
- Parameters:
elem (QDomElement) –
context (
QgsReadWriteContext
= QgsReadWriteContext()) –
- setClassificationMinimumMaximum(self, minimum: float, maximum: float)¶
Sets min/max values used for creation of the color ramp shader
- Parameters:
minimum (float) –
maximum (float) –
- setColorRampShader(self, shader: QgsColorRampShader)¶
Sets color ramp shader function
- Parameters:
shader (QgsColorRampShader) –
- setDataResamplingMethod(self, dataResamplingMethod: QgsMeshRendererScalarSettings.DataResamplingMethod)¶
Sets data interpolation method
New in version 3.12.
- Parameters:
dataResamplingMethod (QgsMeshRendererScalarSettings.DataResamplingMethod) –
- setEdgeStrokeWidth(self, strokeWidth: QgsInterpolatedLineWidth)¶
Sets the stroke width used to render edges scalar dataset
New in version 3.14.
- Parameters:
strokeWidth (QgsInterpolatedLineWidth) –
- setEdgeStrokeWidthUnit(self, edgeStrokeWidthUnit: QgsUnitTypes.RenderUnit)¶
Sets the stroke width unit used to render edges scalar dataset
New in version 3.14.
- Parameters:
edgeStrokeWidthUnit (QgsUnitTypes.RenderUnit) –
- setOpacity(self, opacity: float)¶
Sets opacity
- Parameters:
opacity (float) –
- writeXml(self, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext()) QDomElement ¶
Writes configuration to a new DOM element
- Parameters:
doc (QDomDocument) –
context (
QgsReadWriteContext
= QgsReadWriteContext()) –
- Return type:
QDomElement