Class: QgsArrowSymbolLayer

class qgis.core.QgsArrowSymbolLayer

Bases: qgis._core.QgsLineSymbolLayer

Simple constructor

Line symbol layer used for representing lines as arrows.

New in version 2.16: Enums

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
clone
color
copyDataDefinedProperties
copyPaintEffect
create Create a new QgsArrowSymbolLayer
hasDataDefinedProperties
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
layerType
properties
renderPolyline
restoreOldDataDefinedProperties
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
setColor
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
setSubSymbol
startRender
stopRender
subSymbol
usedAttributes

Signals

Attributes

ArrowLeftHalf
ArrowPlain
ArrowRightHalf
HeadDouble
HeadReversed
HeadSingle
ArrowLeftHalf = 1
ArrowPlain = 0
ArrowRightHalf = 2
class ArrowType

Bases: int

HeadDouble = 2
HeadReversed = 1
HeadSingle = 0
class HeadType

Bases: int

arrowStartWidth(self) → float

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

arrowStartWidthUnit(self) → QgsUnitTypes.RenderUnit

Gets the unit for the arrow start width

arrowStartWidthUnitScale(self) → QgsMapUnitScale

Gets the scale for the arrow start width

arrowType(self) → QgsArrowSymbolLayer.ArrowType

Gets the current arrow type

arrowWidth(self) → float

Gets current arrow width

arrowWidthUnit(self) → QgsUnitTypes.RenderUnit

Gets the unit for the arrow width

arrowWidthUnitScale(self) → QgsMapUnitScale

Gets the scale for the arrow width

clone(self) → QgsArrowSymbolLayer
color(self) → QColor
copyDataDefinedProperties()
copyPaintEffect()
create(properties: Dict[str, str] = {}) → QgsSymbolLayer

Create a new QgsArrowSymbolLayer

Parameters:properties – A property map to deserialize saved information from properties()
Returns:A new QgsArrowSymbolLayer
hasDataDefinedProperties(self) → bool
headLength(self) → float

Gets the current arrow head length

headLengthUnit(self) → QgsUnitTypes.RenderUnit

Gets the unit for the head length

headLengthUnitScale(self) → QgsMapUnitScale

Gets the scale for the head length

headThickness(self) → float

Gets the current arrow head height

headThicknessUnit(self) → QgsUnitTypes.RenderUnit

Gets the unit for the head height

headThicknessUnitScale(self) → QgsMapUnitScale

Gets the scale for the head height

headType(self) → QgsArrowSymbolLayer.HeadType

Gets the current head type

isCurved(self) → bool

Returns whether it is a curved arrow or a straight one

isRepeated(self) → bool

Returns whether the arrow is repeated along the line or not

layerType(self) → str
properties(self) → Dict[str, str]
renderPolyline(self, points: QPolygonF, context: QgsSymbolRenderContext)
restoreOldDataDefinedProperties()
setArrowStartWidth(self, width: float)

Sets the arrow start width

setArrowStartWidthUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the unit for the arrow start width

setArrowStartWidthUnitScale(self, scale: QgsMapUnitScale)

Sets the scale for the arrow start width

setArrowType(self, type: QgsArrowSymbolLayer.ArrowType)

Sets the arrow type

setArrowWidth(self, width: float)

Sets the arrow width

setArrowWidthUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the unit for the arrow width

setArrowWidthUnitScale(self, scale: QgsMapUnitScale)

Sets the scale for the arrow width

setColor(self, c: Union[QColor, Qt.GlobalColor])
setHeadLength(self, length: float)

Sets the arrow head length

setHeadLengthUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the unit for the head length

setHeadLengthUnitScale(self, scale: QgsMapUnitScale)

Sets the scale for the head length

setHeadThickness(self, thickness: float)

Sets the arrow head height

setHeadThicknessUnit(self, unit: QgsUnitTypes.RenderUnit)

Sets the unit for the head height

setHeadThicknessUnitScale(self, scale: QgsMapUnitScale)

Sets the scale for the head height

setHeadType(self, type: QgsArrowSymbolLayer.HeadType)

Sets the head type

setIsCurved(self, isCurved: bool)

Sets whether it is a curved arrow or a straight one

setIsRepeated(self, isRepeated: bool)

Sets whether the arrow is repeated along the line

setSubSymbol(self, symbol: QgsSymbol) → bool
startRender(self, context: QgsSymbolRenderContext)
stopRender(self, context: QgsSymbolRenderContext)
subSymbol(self) → QgsSymbol
usedAttributes(self, context: QgsRenderContext) → Set[str]