Class: QgsMeshRendererVectorSettings

Represents a renderer settings for vector datasets.

Note

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

Added in version 3.2.

class qgis.core.QgsMeshRendererVectorSettings[source]

Bases: object

Arrows = 0
Streamlines = 1
class Symbology

Bases: int

Traces = 2
WindBarbs = 3
arrowSettings(self) → QgsMeshRendererVectorArrowSettings[source]

Returns settings for vector rendered with arrows

Added in version 3.12.

Return type:

QgsMeshRendererVectorArrowSettings

color(self) → QColor[source]

Returns color used for drawing arrows

Return type:

QColor

colorRampShader(self) → QgsColorRampShader[source]

Sets the color ramp shader used to render vector datasets

Added in version 3.14.

Return type:

QgsColorRampShader

coloringMethod(self) → QgsInterpolatedLineColor.ColoringMethod[source]

Returns the coloring method used to render vector datasets

Added in version 3.14.

Return type:

QgsInterpolatedLineColor.ColoringMethod

filterMax(self) → float[source]

Returns filter value for vector magnitudes.

If magnitude of the vector is higher than this value, the vector is not drawn. -1 represents that filtering is not active.

Return type:

float

filterMin(self) → float[source]

Returns filter value for vector magnitudes.

If magnitude of the vector is lower than this value, the vector is not drawn. -1 represents that filtering is not active.

Return type:

float

isOnUserDefinedGrid(self) → bool[source]

Returns whether vectors are drawn on user-defined grid

Return type:

bool

lineWidth(self) → float[source]

Returns line width of the arrow (in millimeters)

Return type:

float

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

Reads configuration from the given DOM element

Parameters:
setArrowsSettings(self, arrowSettings: QgsMeshRendererVectorArrowSettings)[source]

Sets settings for vector rendered with arrows

Added in version 3.12.

Parameters:

arrowSettings (QgsMeshRendererVectorArrowSettings)

setColor(self, color: QColor | Qt.GlobalColor)[source]

Sets color used for drawing arrows

Parameters:

color (Union[QColor, Qt.GlobalColor])

setColorRampShader(self, colorRampShader: QgsColorRampShader)[source]

Returns the color ramp shader used to render vector datasets

Added in version 3.14.

Parameters:

colorRampShader (QgsColorRampShader)

setColoringMethod(self, coloringMethod: QgsInterpolatedLineColor.ColoringMethod)[source]

Sets the coloring method used to render vector datasets

Added in version 3.14.

Parameters:

coloringMethod (QgsInterpolatedLineColor.ColoringMethod)

setFilterMax(self, filterMax: float)[source]

Sets filter value for vector magnitudes.

See also

filterMax()

Parameters:

filterMax (float)

setFilterMin(self, filterMin: float)[source]

Sets filter value for vector magnitudes.

See also

filterMin()

Parameters:

filterMin (float)

setLineWidth(self, lineWidth: float)[source]

Sets line width of the arrow in pixels (in millimeters)

Parameters:

lineWidth (float)

setOnUserDefinedGrid(self, enabled: bool)[source]

Toggles drawing of vectors on user defined grid

Parameters:

enabled (bool)

setStreamLinesSettings(self, streamLinesSettings: QgsMeshRendererVectorStreamlineSettings)[source]

Sets settings for vector rendered with streamlines

Added in version 3.12.

Parameters:

streamLinesSettings (QgsMeshRendererVectorStreamlineSettings)

setSymbology(self, symbology: QgsMeshRendererVectorSettings.Symbology)[source]

Sets the displaying method used to render vector datasets

Added in version 3.12.

Parameters:

symbology (QgsMeshRendererVectorSettings.Symbology)

setTracesSettings(self, tracesSettings: QgsMeshRendererVectorTracesSettings)[source]

Sets settings for vector rendered with traces

Added in version 3.12.

Parameters:

tracesSettings (QgsMeshRendererVectorTracesSettings)

setUserGridCellHeight(self, height: int)[source]

Sets height of user grid cell (in pixels)

Parameters:

height (int)

setUserGridCellWidth(self, width: int)[source]

Sets width of user grid cell (in pixels)

Parameters:

width (int)

setWindBarbSettings(self, windBarbSettings: QgsMeshRendererVectorWindBarbSettings)[source]

Sets settings for vector rendered with wind barbs

Added in version 3.38.

Parameters:

windBarbSettings (QgsMeshRendererVectorWindBarbSettings)

streamLinesSettings(self) → QgsMeshRendererVectorStreamlineSettings[source]

Returns settings for vector rendered with streamlines

Added in version 3.12.

Return type:

QgsMeshRendererVectorStreamlineSettings

symbology(self) → QgsMeshRendererVectorSettings.Symbology[source]

Returns the displaying method used to render vector datasets

Added in version 3.12.

Return type:

QgsMeshRendererVectorSettings.Symbology

tracesSettings(self) → QgsMeshRendererVectorTracesSettings[source]

Returns settings for vector rendered with traces

Added in version 3.12.

Return type:

QgsMeshRendererVectorTracesSettings

userGridCellHeight(self) → int[source]

Returns height in pixels of user grid cell

Return type:

int

userGridCellWidth(self) → int[source]

Returns width in pixels of user grid cell

Return type:

int

vectorStrokeColoring(self) → QgsInterpolatedLineColor[source]

Returns the stroke coloring used to render vector datasets

Added in version 3.14.

Return type:

QgsInterpolatedLineColor

windBarbSettings(self) → QgsMeshRendererVectorWindBarbSettings[source]

Returns settings for vector rendered with wind barbs

Added in version 3.38.

Return type:

QgsMeshRendererVectorWindBarbSettings

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

Writes configuration to a new DOM element

Parameters:
Return type:

QDomElement