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

Methods

classificationMaximum	Returns max value used for creation of the color ramp shader
classificationMinimum	Returns min value used for creation of the color ramp shader
colorRampShader	Returns color ramp shader function
dataInterpolationMethod	Returns the type of interpolation to use to convert face defined datasets to values on vertices
opacity	Returns opacity
readXml	Reads configuration from the given DOM element
setClassificationMinimumMaximum	Sets min/max values used for creation of the color ramp shader
setColorRampShader	Sets color ramp shader function
setDataInterpolationMethod	Sets data interpolation method
setOpacity	Sets opacity
writeXml	Writes configuration to a new DOM element

Attributes

NeighbourAverage
None

class DataInterpolationMethod

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

QgsColorRampShader

dataInterpolationMethod(self) → QgsMeshRendererScalarSettings.DataInterpolationMethod

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

New in version 3.12.

Return type

QgsMeshRendererScalarSettings.DataInterpolationMethod

opacity(self) → float

Returns opacity

Return type

float

readXml(self, elem: QDomElement)

Reads configuration from the given DOM element

Parameters

elem (QDomElement) –

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) –

setDataInterpolationMethod(self, dataInterpolationMethod: QgsMeshRendererScalarSettings.DataInterpolationMethod)

Sets data interpolation method

New in version 3.12.

Parameters

dataInterpolationMethod (QgsMeshRendererScalarSettings.DataInterpolationMethod) –

setOpacity(self, opacity: float)

Sets opacity

Parameters

opacity (float) –

writeXml(self, doc: QDomDocument) → QDomElement

Writes configuration to a new DOM element

Parameters

doc (QDomDocument) –

Return type

QDomElement