Subgroup: other

Class: QgsArrowSymbolLayer¶

class qgis.core.QgsArrowSymbolLayer¶

Bases: qgis._core.QgsLineSymbolLayer

Line symbol layer used for representing lines as arrows.

New in version 2.16: Methods

`arrowStartWidth`	Get current arrow start width.
`arrowStartWidthUnit`	Get the unit for the arrow start width
`arrowStartWidthUnitScale`	Get the scale for the arrow start width
`arrowType`	Get the current arrow type
`arrowWidth`	Get current arrow width
`arrowWidthUnit`	Get the unit for the arrow width
`arrowWidthUnitScale`	Get the scale for the arrow width
`clone`
`color`
`copyDataDefinedProperties`
`copyPaintEffect`
`create`	Create a new QgsArrowSymbolLayer
`dataDefinedProperties`	Returns a reference to the symbol layer’s property collection, used for data defined overrides.
`drawPreviewIcon`
`dxfAngle`	get angle
`dxfBrushColor`	get brush/fill color
`dxfBrushStyle`	get brush/fill style
`dxfColor`	get color
`dxfCustomDashPattern`	get dash pattern
`dxfOffset`	get offset
`dxfPenStyle`	get pen style
`dxfWidth`
`enabled`	Returns true if symbol layer is enabled and will be drawn.
`estimateMaxBleed`	Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context.
`fillColor`	Get fill color.
`headLength`	Get the current arrow head length
`headLengthUnit`	Get the unit for the head length
`headLengthUnitScale`	Get the scale for the head length
`headThickness`	Get the current arrow head height
`headThicknessUnit`	Get the unit for the head height
`headThicknessUnitScale`	Get the scale for the head height
`headType`	Get the current head type
`isCompatibleWithSymbol`	Returns if the layer can be used below the specified symbol
`isCurved`	Return whether it is a curved arrow or a straight one
`isLocked`
`isRepeated`	Return whether the arrow is repeated along the line or not
`layerType`
`mapUnitScale`
`offset`
`offsetMapUnitScale`
`offsetUnit`	Returns the units for the line’s offset.
`ogrFeatureStyle`
`outputUnit`
`paintEffect`	Returns the current paint effect for the layer.
`prepareExpressions`	Prepares all data defined property expressions for evaluation.
`properties`
`propertyDefinitions`	Returns the symbol layer property definitions.
`renderPolygonStroke`
`renderPolyline`
`renderingPass`
`restoreOldDataDefinedProperties`
`setArrowStartWidth`	Set the arrow start width
`setArrowStartWidthUnit`	Set the unit for the arrow start width
`setArrowStartWidthUnitScale`	Set the scale for the arrow start width
`setArrowType`	Set the arrow type
`setArrowWidth`	Set the arrow width
`setArrowWidthUnit`	Set the unit for the arrow width
`setArrowWidthUnitScale`	Set the scale for the arrow width
`setColor`
`setDataDefinedProperties`	Sets the symbol layer’s property collection, used for data defined overrides.
`setDataDefinedProperty`	Sets a data defined property for the layer.
`setEnabled`	Sets whether symbol layer is enabled and should be drawn.
`setFillColor`	Set fill color.
`setHeadLength`	Set the arrow head length
`setHeadLengthUnit`	Set the unit for the head length
`setHeadLengthUnitScale`	Set the scale for the head length
`setHeadThickness`	Set the arrow head height
`setHeadThicknessUnit`	Set the unit for the head height
`setHeadThicknessUnitScale`	Set the scale for the head height
`setHeadType`	Set the head type
`setIsCurved`	Set whether it is a curved arrow or a straight one
`setIsRepeated`	Set whether the arrow is repeated along the line
`setLocked`
`setMapUnitScale`
`setOffset`
`setOffsetMapUnitScale`
`setOffsetUnit`	Sets the units for the line’s offset.
`setOutputUnit`
`setPaintEffect`	Sets the current paint effect for the layer.
`setRenderingPass`
`setStrokeColor`	Set stroke color.
`setSubSymbol`
`setWidth`
`setWidthMapUnitScale`
`setWidthUnit`	Sets the units for the line’s width.
`startRender`
`stopRender`
`strokeColor`	Get stroke color.
`subSymbol`
`toSld`
`type`
`usedAttributes`
`width`
`widthMapUnitScale`
`widthUnit`	Returns the units for the line’s width.
`writeDxf`	write as DXF

Attributes

`ArrowLeftHalf`
`ArrowPlain`
`ArrowRightHalf`
`HeadDouble`
`HeadReversed`
`HeadSingle`
`PropertyAngle`
`PropertyArrowHeadLength`
`PropertyArrowHeadThickness`
`PropertyArrowHeadType`
`PropertyArrowStartWidth`
`PropertyArrowType`
`PropertyArrowWidth`
`PropertyBlurRadius`
`PropertyCapStyle`
`PropertyCharacter`
`PropertyCoordinateMode`
`PropertyCustomDash`
`PropertyDisplacementX`
`PropertyDisplacementY`
`PropertyDistanceX`
`PropertyDistanceY`
`PropertyFile`
`PropertyFillColor`
`PropertyFillStyle`
`PropertyGradientReference1IsCentroid`
`PropertyGradientReference1X`
`PropertyGradientReference1Y`
`PropertyGradientReference2IsCentroid`
`PropertyGradientReference2X`
`PropertyGradientReference2Y`
`PropertyGradientSpread`
`PropertyGradientType`
`PropertyHeight`
`PropertyHorizontalAnchor`
`PropertyInterval`
`PropertyJoinStyle`
`PropertyLayerEnabled`
`PropertyLineAngle`
`PropertyLineDistance`
`PropertyName`
`PropertyOffset`
`PropertyOffsetAlongLine`
`PropertyOpacity`
`PropertyPlacement`
`PropertyPreserveAspectRatio`
`PropertySecondaryColor`
`PropertyShapeburstIgnoreRings`
`PropertyShapeburstMaxDistance`
`PropertyShapeburstUseWholeShape`
`PropertySize`
`PropertyStrokeColor`
`PropertyStrokeStyle`
`PropertyStrokeWidth`
`PropertyVerticalAnchor`
`PropertyWidth`

ArrowLeftHalf = 1¶

ArrowPlain = 0¶

ArrowRightHalf = 2¶

class ArrowType¶: Bases: int

HeadDouble = 2¶

HeadReversed = 1¶

HeadSingle = 0¶

class HeadType¶: Bases: int

arrowStartWidth(self) → float¶: Get current arrow start width. Only meaningful for single headed arrows

arrowStartWidthUnit(self) → QgsUnitTypes.RenderUnit¶: Get the unit for the arrow start width

arrowStartWidthUnitScale(self) → QgsMapUnitScale¶: Get the scale for the arrow start width

arrowType(self) → QgsArrowSymbolLayer.ArrowType¶: Get the current arrow type

arrowWidth(self) → float¶: Get current arrow width

arrowWidthUnit(self) → QgsUnitTypes.RenderUnit¶: Get the unit for the arrow width

arrowWidthUnitScale(self) → QgsMapUnitScale¶: Get 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

headLength(self) → float¶: Get the current arrow head length

headLengthUnit(self) → QgsUnitTypes.RenderUnit¶: Get the unit for the head length

headLengthUnitScale(self) → QgsMapUnitScale¶: Get the scale for the head length

headThickness(self) → float¶: Get the current arrow head height

headThicknessUnit(self) → QgsUnitTypes.RenderUnit¶: Get the unit for the head height

headThicknessUnitScale(self) → QgsMapUnitScale¶: Get the scale for the head height

headType(self) → QgsArrowSymbolLayer.HeadType¶: Get the current head type

isCurved(self) → bool¶: Return whether it is a curved arrow or a straight one

isRepeated(self) → bool¶: Return 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)¶: Set the arrow start width

setArrowStartWidthUnit(self, unit: QgsUnitTypes.RenderUnit)¶: Set the unit for the arrow start width

setArrowStartWidthUnitScale(self, scale: QgsMapUnitScale)¶: Set the scale for the arrow start width

setArrowType(self, type: QgsArrowSymbolLayer.ArrowType)¶: Set the arrow type

setArrowWidth(self, width: float)¶: Set the arrow width

setArrowWidthUnit(self, unit: QgsUnitTypes.RenderUnit)¶: Set the unit for the arrow width

setArrowWidthUnitScale(self, scale: QgsMapUnitScale)¶: Set the scale for the arrow width

setColor(self, c: Union[QColor, Qt.GlobalColor])¶

setHeadLength(self, length: float)¶: Set the arrow head length

setHeadLengthUnit(self, unit: QgsUnitTypes.RenderUnit)¶: Set the unit for the head length

setHeadLengthUnitScale(self, scale: QgsMapUnitScale)¶: Set the scale for the head length

setHeadThickness(self, thickness: float)¶: Set the arrow head height

setHeadThicknessUnit(self, unit: QgsUnitTypes.RenderUnit)¶: Set the unit for the head height

setHeadThicknessUnitScale(self, scale: QgsMapUnitScale)¶: Set the scale for the head height

setHeadType(self, type: QgsArrowSymbolLayer.HeadType)¶: Set the head type

setIsCurved(self, isCurved: bool)¶: Set whether it is a curved arrow or a straight one

setIsRepeated(self, isRepeated: bool)¶: Set 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]¶