Class: QgsMeshRendererVectorTracesSettings

class qgis.core.QgsMeshRendererVectorTracesSettings

Bases: sip.wrapper

Represents a trace renderer settings for vector datasets displayed by particle traces

Note

The API is considered EXPERIMENTAL and can be changed without a notice

Methods

maximumTailLength

Returns the maximum tail length

maximumTailLengthUnit

Returns the maximum tail length unit

particlesCount

Returns particles count

readXml

Reads configuration from the given DOM element

setMaximumTailLength

Sets the maximums tail length

setMaximumTailLengthUnit

Sets the maximum tail length unit

setParticlesCount

Sets particles count

writeXml

Writes configuration to a new DOM element

maximumTailLength(self) → float

Returns the maximum tail length

Return type

float

maximumTailLengthUnit(self)QgsUnitTypes.RenderUnit

Returns the maximum tail length unit

Return type

QgsUnitTypes.RenderUnit

particlesCount(self) → int

Returns particles count

Return type

int

readXml(self, elem: QDomElement)

Reads configuration from the given DOM element

Parameters

elem (QDomElement) –

setMaximumTailLength(self, maximumTailLength: float)

Sets the maximums tail length

Parameters

maximumTailLength (float) –

setMaximumTailLengthUnit(self, maximumTailLengthUnit: QgsUnitTypes.RenderUnit)

Sets the maximum tail length unit

Parameters

maximumTailLengthUnit (QgsUnitTypes.RenderUnit) –

setParticlesCount(self, value: int)

Sets particles count

Parameters

value (int) –

writeXml(self, doc: QDomDocument) → QDomElement

Writes configuration to a new DOM element

Parameters

doc (QDomDocument) –

Return type

QDomElement