Class: QgsMeshRendererScalarSettings¶

Represents a mesh renderer settings for scalar datasets.

Note

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

Added in version 3.2.

class qgis.core.QgsMeshRendererScalarSettings[source]¶

Bases: object

class DataResamplingMethod¶: Bases: int

NeighbourAverage = 1¶

NoResampling = 0¶

classificationMaximum(self) → float[source]¶

Returns max value used for creation of the color ramp shader

Return type:: float

classificationMinimum(self) → float[source]¶

Returns min value used for creation of the color ramp shader

Return type:: float

colorRampShader(self) → QgsColorRampShader[source]¶

Returns color ramp shader function

Return type:: QgsColorRampShader

dataResamplingMethod(self) → QgsMeshRendererScalarSettings.DataResamplingMethod[source]¶

Returns the type of interpolation to use to convert face defined datasets to values on vertices

Added in version 3.12.

Return type:: QgsMeshRendererScalarSettings.DataResamplingMethod

edgeStrokeWidth(self) → QgsInterpolatedLineWidth[source]¶

Returns the stroke width used to render edges scalar dataset

Added in version 3.14.

Return type:: QgsInterpolatedLineWidth

edgeStrokeWidthUnit(self) → Qgis.RenderUnit[source]¶

Returns the stroke width unit used to render edges scalar dataset

Added in version 3.14.

Return type:: Qgis.RenderUnit

extent(self) → Qgis.MeshRangeExtent[source]¶

Returns the mesh extent for minimum maximum calculation

Added in version 3.42.

Return type:: Qgis.MeshRangeExtent

limits(self) → Qgis.MeshRangeLimit[source]¶

Returns the range limits type for minimum maximum calculation

Added in version 3.42.

Return type:: Qgis.MeshRangeLimit

opacity(self) → float[source]¶

Returns opacity

Return type:: float

readXml(self, elem: QDomElement, context: QgsReadWriteContext = QgsReadWriteContext())[source]¶

Reads configuration from the given DOM element

Parameters:

elem (QDomElement)
context (QgsReadWriteContext = QgsReadWriteContext())

setClassificationMinimumMaximum(self, minimum: float, maximum: float)[source]¶

Sets min/max values used for creation of the color ramp shader

Parameters:

minimum (float)
maximum (float)

setColorRampShader(self, shader: QgsColorRampShader)[source]¶

Sets color ramp shader function

Parameters:: shader (QgsColorRampShader)

setDataResamplingMethod(self, dataResamplingMethod: QgsMeshRendererScalarSettings.DataResamplingMethod)[source]¶

Sets data interpolation method

Added in version 3.12.

Parameters:: dataResamplingMethod (QgsMeshRendererScalarSettings.DataResamplingMethod)

setEdgeStrokeWidth(self, strokeWidth: QgsInterpolatedLineWidth)[source]¶

Sets the stroke width used to render edges scalar dataset

Added in version 3.14.

Parameters:: strokeWidth (QgsInterpolatedLineWidth)

setEdgeStrokeWidthUnit(self, edgeStrokeWidthUnit: Qgis.RenderUnit)[source]¶

Sets the stroke width unit used to render edges scalar dataset

Added in version 3.14.

Parameters:: edgeStrokeWidthUnit (Qgis.RenderUnit)

setExtent(self, extent: Qgis.MeshRangeExtent)[source]¶

Sets the mesh extent for minimum maximum calculation

Added in version 3.42.

Parameters:: extent (Qgis.MeshRangeExtent)

setLimits(self, limits: Qgis.MeshRangeLimit)[source]¶

Sets the range limits type for minimum maximum calculation

Added in version 3.42.

Parameters:: limits (Qgis.MeshRangeLimit)

setOpacity(self, opacity: float)[source]¶

Sets opacity

Parameters:: opacity (float)

writeXml(self, doc: QDomDocument, context: QgsReadWriteContext = QgsReadWriteContext()) → QDomElement[source]¶

Writes configuration to a new DOM element

Parameters:

doc (QDomDocument)
context (QgsReadWriteContext = QgsReadWriteContext())

Return type:

QDomElement