Class: QgsVectorFieldSymbolLayer

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

Class Hierarchy

Inheritance diagram of qgis.core.QgsVectorFieldSymbolLayer

Base classes

QgsMarkerSymbolLayer

Abstract base class for marker symbol layers.

QgsSymbolLayer

Abstract base class for symbol layers.
class qgis.core.QgsVectorFieldSymbolLayer[source]

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[source]
Return type:

QgsVectorFieldSymbolLayer.AngleOrientation

angleUnits(self) → QgsVectorFieldSymbolLayer.AngleUnits[source]
Return type:

QgsVectorFieldSymbolLayer.AngleUnits

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

Creates the symbol layer

Parameters:

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

Return type:

Optional[QgsSymbolLayer]

static createFromSld(element: QDomElement) → QgsSymbolLayer | None[source]
Parameters:

element (QDomElement)

Return type:

Optional[QgsSymbolLayer]

distanceMapUnitScale(self) → QgsMapUnitScale
Return type:

QgsMapUnitScale

distanceUnit(self) → Qgis.RenderUnit[source]

Returns the units for the distance.

See also

setDistanceUnit()

Return type:

Qgis.RenderUnit

scale(self) → float[source]
Return type:

float

setAngleOrientation(self, orientation: QgsVectorFieldSymbolLayer.AngleOrientation)[source]
Parameters:

orientation (QgsVectorFieldSymbolLayer.AngleOrientation)

setAngleUnits(self, units: QgsVectorFieldSymbolLayer.AngleUnits)[source]
Parameters:

units (QgsVectorFieldSymbolLayer.AngleUnits)

setDistanceMapUnitScale(self, scale: QgsMapUnitScale)[source]
Parameters:

scale (QgsMapUnitScale)

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

Sets the units for the distance.

Parameters:

unit (Qgis.RenderUnit) – distance units

See also

distanceUnit()

setScale(self, s: float)[source]
Parameters:

s (float)

setVectorFieldType(self, type: QgsVectorFieldSymbolLayer.VectorFieldType)[source]
Parameters:

type (QgsVectorFieldSymbolLayer.VectorFieldType)

setXAttribute(self, attribute: str | None)[source]
Parameters:

attribute (Optional[str])

setYAttribute(self, attribute: str | None)[source]
Parameters:

attribute (Optional[str])

vectorFieldType(self) → QgsVectorFieldSymbolLayer.VectorFieldType[source]
Return type:

QgsVectorFieldSymbolLayer.VectorFieldType

xAttribute(self) → str[source]
Return type:

str

yAttribute(self) → str[source]
Return type:

str