Class: QgsVectorFieldSymbolLayer

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

Class Hierarchy

Base classes

QgsMarkerSymbolLayer	Abstract base class for marker symbol layers.
QgsSymbolLayer	Constructor for QgsSymbolLayer.

Methods

angleOrientation
angleUnits
distanceMapUnitScale
distanceUnit	Returns the units for the distance.
scale
setAngleOrientation
setAngleUnits
setDistanceMapUnitScale
setDistanceUnit	Sets the units for the distance.
setScale
setVectorFieldType
setXAttribute
setYAttribute
vectorFieldType
xAttribute
yAttribute

Static Methods

create	Creates the symbol layer
createFromSld

Attributes

Cartesian
ClockwiseFromNorth
CounterclockwiseFromEast
Degrees
Height
Polar
Radians

class qgis.core.QgsVectorFieldSymbolLayer

Bases: QgsMarkerSymbolLayer

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

Return type:

QgsVectorFieldSymbolLayer.AngleOrientation

angleUnits(self) → QgsVectorFieldSymbolLayer.AngleUnits

Return type:

QgsVectorFieldSymbolLayer.AngleUnits

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

Creates the symbol layer

Parameters:

properties (Dict[str, Any] = {})

Return type:

Optional[QgsSymbolLayer]

static createFromSld(element: QDomElement) → QgsSymbolLayer | None

Parameters:

element (QDomElement)

Return type:

Optional[QgsSymbolLayer]

distanceMapUnitScale(self) → QgsMapUnitScale

Return type:

QgsMapUnitScale

distanceUnit(self) → Qgis.RenderUnit

Returns the units for the distance.

See also

setDistanceUnit()

Return type:

Qgis.RenderUnit

scale(self) → float

Return type:

float

setAngleOrientation(self, orientation: QgsVectorFieldSymbolLayer.AngleOrientation)

Parameters:

orientation (QgsVectorFieldSymbolLayer.AngleOrientation)

setAngleUnits(self, units: QgsVectorFieldSymbolLayer.AngleUnits)

Parameters:

units (QgsVectorFieldSymbolLayer.AngleUnits)

setDistanceMapUnitScale(self, scale: QgsMapUnitScale)

Parameters:

scale (QgsMapUnitScale)

setDistanceUnit(self, unit: Qgis.RenderUnit)

Sets the units for the distance.

Parameters:

unit (Qgis.RenderUnit) – distance units

See also

distanceUnit()

setScale(self, s: float)

Parameters:

s (float)

setVectorFieldType(self, type: QgsVectorFieldSymbolLayer.VectorFieldType)

Parameters:

type (QgsVectorFieldSymbolLayer.VectorFieldType)

setXAttribute(self, attribute: str | None)

Parameters:

attribute (Optional[str])

setYAttribute(self, attribute: str | None)

Parameters:

attribute (Optional[str])

vectorFieldType(self) → QgsVectorFieldSymbolLayer.VectorFieldType

Return type:

QgsVectorFieldSymbolLayer.VectorFieldType

xAttribute(self) → str

Return type:

str

yAttribute(self) → str

Return type:

str