Subgroup: Vector

Class: QgsVectorFieldSymbolLayer¶

class qgis.core.QgsVectorFieldSymbolLayer¶

Bases: qgis._core.QgsMarkerSymbolLayer

A symbol layer class for displaying displacement arrows based on point layer attributes*

Methods

angle Returns the rotation angle for the marker, in degrees clockwise from north.

angleOrientation

angleUnits

bounds

clone

color

copyDataDefinedProperties

copyPaintEffect

create

createFromSld

dataDefinedProperties Returns a reference to the symbol layer’s property collection, used for data defined overrides.

distanceMapUnitScale

distanceUnit Returns the units for the distance.

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 get line width

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.

horizontalAnchorPoint Returns the horizontal anchor point for positioning the symbol.

isCompatibleWithSymbol Returns if the layer can be used below the specified symbol

isLocked

layerType

mapUnitScale

markerOffset

markerOffset2

markerOffsetWithWidthAndHeight

offset Returns the marker’s offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature’s geometry.

offsetMapUnitScale Returns the map unit scale for the symbol’s offset.

offsetUnit Returns the units for the symbol’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.

renderPoint

renderingPass

restoreOldDataDefinedProperties

scale

scaleMethod Returns the method to use for scaling the marker’s size.

setAngle Sets the rotation angle for the marker.

setAngleOrientation

setAngleUnits

setColor

setDataDefinedProperties Sets the symbol layer’s property collection, used for data defined overrides.

setDataDefinedProperty Sets a data defined property for the layer.

setDistanceMapUnitScale

setDistanceUnit Sets the units for the distance.

setEnabled Sets whether symbol layer is enabled and should be drawn.

setFillColor Set fill color.

setHorizontalAnchorPoint Sets the horizontal anchor point for positioning the symbol.

setLineAngle Sets the line angle modification for the symbol’s angle.

setLocked

setMapUnitScale

setOffset Sets the marker’s offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature’s geometry.

setOffsetMapUnitScale Sets the map unit scale for the symbol’s offset.

setOffsetUnit Sets the units for the symbol’s offset.

setOutputUnit

setPaintEffect Sets the current paint effect for the layer.

setRenderingPass

setScale

setScaleMethod Sets the method to use for scaling the marker’s size.

setSize Sets the symbol size.

setSizeMapUnitScale Sets the map unit scale for the symbol’s size.

setSizeUnit Sets the units for the symbol’s size.

setStrokeColor Set stroke color.

setSubSymbol

setVectorFieldType

setVerticalAnchorPoint Sets the vertical anchor point for positioning the symbol.

setXAttribute

setYAttribute

size Returns the symbol size.

sizeMapUnitScale Returns the map unit scale for the symbol’s size.

sizeUnit Returns the units for the symbol’s size.

startRender

stopRender

strokeColor Get stroke color.

subSymbol

toSld

type

usedAttributes

vectorFieldType

verticalAnchorPoint Returns the vertical anchor point for positioning the symbol.

writeDxf write as DXF

writeSldMarker Writes the symbol layer definition as a SLD XML element.

xAttribute

yAttribute

Attributes

Bottom

Cartesian

ClockwiseFromNorth

CounterclockwiseFromEast

Degrees

HCenter

Height

Left

Polar

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

Radians

Right

Top

VCenter

class AngleOrientation¶: Bases: int

class AngleUnits¶: Bases: int

Cartesian = 0¶

ClockwiseFromNorth = 0¶

CounterclockwiseFromEast = 1¶

Degrees = 0¶

Height = 2¶

Polar = 1¶

Radians = 1¶

class VectorFieldType¶: Bases: int

angleOrientation(self) → QgsVectorFieldSymbolLayer.AngleOrientation¶

angleUnits(self) → QgsVectorFieldSymbolLayer.AngleUnits¶

bounds(self, Union[QPointF, QPoint], QgsSymbolRenderContext) → QRectF¶

clone(self) → QgsVectorFieldSymbolLayer¶

color(self) → QColor¶

copyDataDefinedProperties()¶

copyPaintEffect()¶

create(properties: Dict[str, str] = {}) → QgsSymbolLayer¶

createFromSld(element: QDomElement) → QgsSymbolLayer¶

distanceMapUnitScale(self) → QgsMapUnitScale¶

distanceUnit(self) → QgsUnitTypes.RenderUnit¶: Returns the units for the distance.

See also

setDistanceUnit()

drawPreviewIcon(self, context: QgsSymbolRenderContext, size: QSize)¶

layerType(self) → str¶

mapUnitScale(self) → QgsMapUnitScale¶

markerOffset()¶

markerOffset2()¶

markerOffsetWithWidthAndHeight()¶

outputUnit(self) → QgsUnitTypes.RenderUnit¶

properties(self) → Dict[str, str]¶

renderPoint(self, point: Union[QPointF, QPoint], context: QgsSymbolRenderContext)¶

restoreOldDataDefinedProperties()¶

scale(self) → float¶

setAngleOrientation(self, orientation: QgsVectorFieldSymbolLayer.AngleOrientation)¶

setAngleUnits(self, units: QgsVectorFieldSymbolLayer.AngleUnits)¶

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

setDistanceMapUnitScale(self, scale: QgsMapUnitScale)¶

setDistanceUnit(self, unit: QgsUnitTypes.RenderUnit)¶

Sets the units for the distance.

Parameters:	unit – distance units