Class: QgsMeshRendererVectorArrowSettings¶

Represents a mesh renderer settings for vector datasets displayed with arrows.

Note

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

Added in version 3.12.

Methods

`arrowHeadLengthRatio`	Returns ratio of the head length of the arrow (range 0-1)
`arrowHeadWidthRatio`	Returns ratio of the head width of the arrow (range 0-1)
`fixedShaftLength`	Returns fixed arrow length (in millimeters)
`maxShaftLength`	Returns maximum shaft length (in millimeters)
`minShaftLength`	Returns mininimum shaft length (in millimeters)
`readXml`	Reads configuration from the given DOM element
`scaleFactor`	Returns scale factor
`setArrowHeadLengthRatio`	Sets ratio of the head length of the arrow (range 0-1)
`setArrowHeadWidthRatio`	Sets ratio of the head width of the arrow (range 0-1)
`setFixedShaftLength`	Sets fixed length (in millimeters)
`setMaxShaftLength`	Sets maximum shaft length (in millimeters)
`setMinShaftLength`	Sets mininimum shaft length (in millimeters)
`setScaleFactor`	Sets scale factor
`setShaftLengthMethod`	Sets method used for drawing arrows
`shaftLengthMethod`	Returns method used for drawing arrows
`writeXml`	Writes configuration to a new DOM element

Attributes

`Fixed`
`MinMax`
`Scaled`

class qgis.core.QgsMeshRendererVectorArrowSettings[source]¶

Bases: object

class ArrowScalingMethod¶: Bases: int

Fixed = 2¶

MinMax = 0¶

Scaled = 1¶

arrowHeadLengthRatio(self) → float[source]¶

Returns ratio of the head length of the arrow (range 0-1)

Return type:: float

arrowHeadWidthRatio(self) → float[source]¶

Returns ratio of the head width of the arrow (range 0-1)

Return type:: float

fixedShaftLength(self) → float[source]¶

Returns fixed arrow length (in millimeters)

Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.Fixed

Return type:: float

maxShaftLength(self) → float[source]¶

Returns maximum shaft length (in millimeters)

Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.MinMax

Return type:: float

minShaftLength(self) → float[source]¶

Returns mininimum shaft length (in millimeters)

Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.MinMax

Return type:: float

readXml(self, elem: QDomElement)[source]¶

Reads configuration from the given DOM element

Parameters:: elem (QDomElement)

scaleFactor(self) → float[source]¶

Returns scale factor

Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.Scaled

Return type:: float

setArrowHeadLengthRatio(self, arrowHeadLengthRatio: float)[source]¶

Sets ratio of the head length of the arrow (range 0-1)

Parameters:: arrowHeadLengthRatio (float)

setArrowHeadWidthRatio(self, arrowHeadWidthRatio: float)[source]¶

Sets ratio of the head width of the arrow (range 0-1)

Parameters:: arrowHeadWidthRatio (float)

setFixedShaftLength(self, fixedShaftLength: float)[source]¶

Sets fixed length (in millimeters)

Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.Fixed

Parameters:: fixedShaftLength (float)

setMaxShaftLength(self, maxShaftLength: float)[source]¶

Sets maximum shaft length (in millimeters)

Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.MinMax

Parameters:: maxShaftLength (float)

setMinShaftLength(self, minShaftLength: float)[source]¶

Sets mininimum shaft length (in millimeters)

Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.MinMax

Parameters:: minShaftLength (float)

setScaleFactor(self, scaleFactor: float)[source]¶

Sets scale factor

Only for QgsMeshRendererVectorSettings.ArrowScalingMethod.Scaled

Parameters:: scaleFactor (float)

setShaftLengthMethod(self, shaftLengthMethod: QgsMeshRendererVectorArrowSettings.ArrowScalingMethod)[source]¶

Sets method used for drawing arrows

Parameters:: shaftLengthMethod (QgsMeshRendererVectorArrowSettings.ArrowScalingMethod)

shaftLengthMethod(self) → QgsMeshRendererVectorArrowSettings.ArrowScalingMethod[source]¶

Returns method used for drawing arrows

Return type:: QgsMeshRendererVectorArrowSettings.ArrowScalingMethod

writeXml(self, doc: QDomDocument) → QDomElement[source]¶

Writes configuration to a new DOM element

Parameters:: doc (QDomDocument)
Return type:: QDomElement