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.

Methods

`arrowSettings`	Returns settings for vector rendered with arrows
`color`	Returns color used for drawing arrows
`colorRampShader`	Sets the color ramp shader used to render vector datasets
`coloringMethod`	Returns the coloring method used to render vector datasets
`filterMax`	Returns filter value for vector magnitudes.
`filterMin`	Returns filter value for vector magnitudes.
`isOnUserDefinedGrid`	Returns whether vectors are drawn on user-defined grid
`lineWidth`	Returns line width of the arrow (in millimeters)
`readXml`	Reads configuration from the given DOM element
`setArrowsSettings`	Sets settings for vector rendered with arrows
`setColor`	Sets color used for drawing arrows
`setColorRampShader`	Returns the color ramp shader used to render vector datasets
`setColoringMethod`	Sets the coloring method used to render vector datasets
`setFilterMax`	Sets filter value for vector magnitudes.
`setFilterMin`	Sets filter value for vector magnitudes.
`setLineWidth`	Sets line width of the arrow in pixels (in millimeters)
`setOnUserDefinedGrid`	Toggles drawing of vectors on user defined grid
`setStreamLinesSettings`	Sets settings for vector rendered with streamlines
`setSymbology`	Sets the displaying method used to render vector datasets
`setTracesSettings`	Sets settings for vector rendered with traces
`setUserGridCellHeight`	Sets height of user grid cell (in pixels)
`setUserGridCellWidth`	Sets width of user grid cell (in pixels)
`setWindBarbSettings`	Sets settings for vector rendered with wind barbs
`streamLinesSettings`	Returns settings for vector rendered with streamlines
`symbology`	Returns the displaying method used to render vector datasets
`tracesSettings`	Returns settings for vector rendered with traces
`userGridCellHeight`	Returns height in pixels of user grid cell
`userGridCellWidth`	Returns width in pixels of user grid cell
`vectorStrokeColoring`	Returns the stroke coloring used to render vector datasets
`windBarbSettings`	Returns settings for vector rendered with wind barbs
`writeXml`	Writes configuration to a new DOM element

Attributes

`Arrows`
`Streamlines`
`Traces`
`WindBarbs`

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:

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

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.