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

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

edgeStrokeWidth

Returns the stroke width used to render edges scalar dataset

edgeStrokeWidthUnit

Returns the stroke width unit used to render edges scalar dataset

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

setEdgeStrokeWidth

Sets the stroke width used to render edges scalar dataset

setEdgeStrokeWidthUnit

Sets the stroke width unit used to render edges scalar dataset

setOpacity

Sets opacity

writeXml

Writes configuration to a new DOM element

Attributes

NeighbourAverage

NoResampling

class DataResamplingMethod

Bases: int

NeighbourAverage = 1
NoResampling = 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

edgeStrokeWidth(self) QgsInterpolatedLineWidth

Returns the stroke width used to render edges scalar dataset

New in version 3.14.

Return type:

QgsInterpolatedLineWidth

edgeStrokeWidthUnit(self) Qgis.RenderUnit

Returns the stroke width unit used to render edges scalar dataset

New in version 3.14.

Return type:

Qgis.RenderUnit

opacity(self) float

Returns opacity

Return type:

float

readXml(self, elem: QDomElement, context: QgsReadWriteContext = QgsReadWriteContext())

Reads configuration from the given DOM element

Parameters:
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: Qgis.RenderUnit)

Sets the stroke width unit used to render edges scalar dataset

New in version 3.14.

Parameters:

edgeStrokeWidthUnit (Qgis.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:
Return type:

QDomElement