Class: QgsArrowSymbolLayer¶

Line symbol layer used for representing lines as arrows.

Class Hierarchy¶

Base classes¶

`QgsLineSymbolLayer`	Abstract base class for line symbol layers.
`QgsSymbolLayer`	Abstract base class for symbol layers.

Methods

`arrowStartWidth`	Gets current arrow start width.
`arrowStartWidthUnit`	Gets the unit for the arrow start width
`arrowStartWidthUnitScale`	Gets the scale for the arrow start width
`arrowType`	Gets the current arrow type
`arrowWidth`	Gets current arrow width
`arrowWidthUnit`	Gets the unit for the arrow width
`arrowWidthUnitScale`	Gets the scale for the arrow width
`headLength`	Gets the current arrow head length
`headLengthUnit`	Gets the unit for the head length
`headLengthUnitScale`	Gets the scale for the head length
`headThickness`	Gets the current arrow head height
`headThicknessUnit`	Gets the unit for the head height
`headThicknessUnitScale`	Gets the scale for the head height
`headType`	Gets the current head type
`isCurved`	Returns whether it is a curved arrow or a straight one
`isRepeated`	Returns whether the arrow is repeated along the line or not
`setArrowStartWidth`	Sets the arrow start width
`setArrowStartWidthUnit`	Sets the unit for the arrow start width
`setArrowStartWidthUnitScale`	Sets the scale for the arrow start width
`setArrowType`	Sets the arrow type
`setArrowWidth`	Sets the arrow width
`setArrowWidthUnit`	Sets the unit for the arrow width
`setArrowWidthUnitScale`	Sets the scale for the arrow width
`setHeadLength`	Sets the arrow head length
`setHeadLengthUnit`	Sets the unit for the head length
`setHeadLengthUnitScale`	Sets the scale for the head length
`setHeadThickness`	Sets the arrow head height
`setHeadThicknessUnit`	Sets the unit for the head height
`setHeadThicknessUnitScale`	Sets the scale for the head height
`setHeadType`	Sets the head type
`setIsCurved`	Sets whether it is a curved arrow or a straight one
`setIsRepeated`	Sets whether the arrow is repeated along the line

Static Methods

create

Create a new QgsArrowSymbolLayer

Attributes

`ArrowLeftHalf`
`ArrowPlain`
`ArrowRightHalf`
`HeadDouble`
`HeadReversed`
`HeadSingle`

class qgis.core.QgsArrowSymbolLayer[source]¶

Bases: QgsLineSymbolLayer

__init__(): Simple constructor

ArrowLeftHalf = 1¶

ArrowPlain = 0¶

ArrowRightHalf = 2¶

class ArrowType¶: Bases: int

HeadDouble = 2¶

HeadReversed = 1¶

HeadSingle = 0¶

class HeadType¶: Bases: int

arrowStartWidth(self) → float[source]¶

Gets current arrow start width. Only meaningful for single headed arrows

Return type:: float

arrowStartWidthUnit(self) → Qgis.RenderUnit[source]¶

Gets the unit for the arrow start width

Return type:: Qgis.RenderUnit

arrowStartWidthUnitScale(self) → QgsMapUnitScale[source]¶

Gets the scale for the arrow start width

Return type:: QgsMapUnitScale

arrowType(self) → QgsArrowSymbolLayer.ArrowType[source]¶

Gets the current arrow type

Return type:: QgsArrowSymbolLayer.ArrowType

arrowWidth(self) → float[source]¶

Gets current arrow width

Return type:: float

arrowWidthUnit(self) → Qgis.RenderUnit[source]¶

Gets the unit for the arrow width

Return type:: Qgis.RenderUnit

arrowWidthUnitScale(self) → QgsMapUnitScale[source]¶

Gets the scale for the arrow width

Return type:: QgsMapUnitScale

static create(properties: Dict[str, Any] = {}) → QgsSymbolLayer | None[source]¶

Create a new QgsArrowSymbolLayer

Parameters:: properties (Dict[str, Any] = {}) – A property map to deserialize saved information from properties()
Return type:: Optional[QgsSymbolLayer]
Returns:: A new QgsArrowSymbolLayer

headLength(self) → float[source]¶

Gets the current arrow head length

Return type:: float

headLengthUnit(self) → Qgis.RenderUnit[source]¶

Gets the unit for the head length

Return type:: Qgis.RenderUnit

headLengthUnitScale(self) → QgsMapUnitScale[source]¶

Gets the scale for the head length

Return type:: QgsMapUnitScale

headThickness(self) → float[source]¶

Gets the current arrow head height

Return type:: float

headThicknessUnit(self) → Qgis.RenderUnit[source]¶

Gets the unit for the head height

Return type:: Qgis.RenderUnit

headThicknessUnitScale(self) → QgsMapUnitScale[source]¶

Gets the scale for the head height

Return type:: QgsMapUnitScale

headType(self) → QgsArrowSymbolLayer.HeadType[source]¶

Gets the current head type

Return type:: QgsArrowSymbolLayer.HeadType

isCurved(self) → bool[source]¶

Returns whether it is a curved arrow or a straight one

Return type:: bool

isRepeated(self) → bool[source]¶

Returns whether the arrow is repeated along the line or not

Return type:: bool

setArrowStartWidth(self, width: float)[source]¶

Sets the arrow start width

Parameters:: width (float)

setArrowStartWidthUnit(self, unit: Qgis.RenderUnit)[source]¶

Sets the unit for the arrow start width

Parameters:: unit (Qgis.RenderUnit)

setArrowStartWidthUnitScale(self, scale: QgsMapUnitScale)[source]¶

Sets the scale for the arrow start width

Parameters:: scale (QgsMapUnitScale)

setArrowType(self, type: QgsArrowSymbolLayer.ArrowType)[source]¶

Sets the arrow type

Parameters:: type (QgsArrowSymbolLayer.ArrowType)

setArrowWidth(self, width: float)[source]¶

Sets the arrow width

Parameters:: width (float)

setArrowWidthUnit(self, unit: Qgis.RenderUnit)[source]¶

Sets the unit for the arrow width

Parameters:: unit (Qgis.RenderUnit)

setArrowWidthUnitScale(self, scale: QgsMapUnitScale)[source]¶

Sets the scale for the arrow width

Parameters:: scale (QgsMapUnitScale)

setHeadLength(self, length: float)[source]¶

Sets the arrow head length

Parameters:: length (float)

setHeadLengthUnit(self, unit: Qgis.RenderUnit)[source]¶

Sets the unit for the head length

Parameters:: unit (Qgis.RenderUnit)

setHeadLengthUnitScale(self, scale: QgsMapUnitScale)[source]¶

Sets the scale for the head length

Parameters:: scale (QgsMapUnitScale)

setHeadThickness(self, thickness: float)[source]¶

Sets the arrow head height

Parameters:: thickness (float)

setHeadThicknessUnit(self, unit: Qgis.RenderUnit)[source]¶

Sets the unit for the head height

Parameters:: unit (Qgis.RenderUnit)

setHeadThicknessUnitScale(self, scale: QgsMapUnitScale)[source]¶

Sets the scale for the head height

Parameters:: scale (QgsMapUnitScale)

setHeadType(self, type: QgsArrowSymbolLayer.HeadType)[source]¶

Sets the head type

Parameters:: type (QgsArrowSymbolLayer.HeadType)

setIsCurved(self, isCurved: bool)[source]¶

Sets whether it is a curved arrow or a straight one

Parameters:: isCurved (bool)

setIsRepeated(self, isRepeated: bool)[source]¶

Sets whether the arrow is repeated along the line

Parameters:: isRepeated (bool)