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

dataResamplingMethod

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

edgeWidth

Returns width of the edge

edgeWidthUnit

Returns length units of the width of the edge

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

setDataResamplingMethod

Sets data interpolation method

setEdgeWidth

Sets width of the edge

setEdgeWidthUnit

Sets length units of the width of the edge

setOpacity

Sets opacity

writeXml

Writes configuration to a new DOM element

Attributes

NeighbourAverage

None

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

QgsColorRampShader

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

QgsMeshRendererScalarSettings.DataResamplingMethod

edgeWidth(self) → float

Returns width of the edge

New in version 3.14.

Return type

float

edgeWidthUnit(self) → QgsUnitTypes.RenderUnit

Returns length units of the width of the edge

New in version 3.14.

Return type

QgsUnitTypes.RenderUnit

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

setDataResamplingMethod(self, dataResamplingMethod: QgsMeshRendererScalarSettings.DataResamplingMethod)

Sets data interpolation method

New in version 3.12.

Parameters

dataResamplingMethod (QgsMeshRendererScalarSettings.DataResamplingMethod) –

setEdgeWidth(self, edgeWidth: float)

Sets width of the edge

New in version 3.14.

Parameters

edgeWidth (float) –

setEdgeWidthUnit(self, edgeWidthUnit: QgsUnitTypes.RenderUnit)

Sets length units of the width of the edge

New in version 3.14.

Parameters

edgeWidthUnit (QgsUnitTypes.RenderUnit) –

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