Class: QgsEmbeddedSymbolRenderer¶

A vector feature renderer which uses embedded feature symbology to render per-feature symbols.

This renderer can be used for vector layers with a data provider which supports the QgsVectorDataProvider.FeatureSymbology capability, where the dataset has embedded information on how each feature should be rendered.

Added in version 3.20.

Class Hierarchy¶

Base classes¶

QgsFeatureRenderer

Abstract base class for all 2D vector feature renderers.

Methods

`defaultSymbol`	Returns the default symbol which will be rendered for any feature which does not have embedded symbology.
`setDefaultSymbol`	Sets the default symbol which will be rendered for any feature which does not have embedded symbology.

Static Methods

`convertFromRenderer`	Creates a `QgsEmbeddedSymbolRenderer` from an existing renderer.
`create`	Creates a new embedded symbol renderer from an XML element, using the supplied read/write context.

class qgis.core.QgsEmbeddedSymbolRenderer[source]¶

Bases: QgsFeatureRenderer

__init__(defaultSymbol: QgsSymbol | None)

Constructor for QgsEmbeddedSymbolRenderer.

The defaultSymbol will be used to render any feature without embedded symbology. Ownership of defaultSymbol is transferred to the renderer.

Parameters:: defaultSymbol (Optional[QgsSymbol])

static convertFromRenderer(renderer: QgsFeatureRenderer | None) → QgsEmbeddedSymbolRenderer | None[source]¶

Creates a QgsEmbeddedSymbolRenderer from an existing renderer.

Return type:: Optional[QgsEmbeddedSymbolRenderer]
Returns:: a new renderer if the conversion was possible, otherwise None.
Parameters:: renderer (Optional[QgsFeatureRenderer])

static create(element: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer | None[source]¶

Creates a new embedded symbol renderer from an XML element, using the supplied read/write context.

The caller takes ownership of the returned renderer.

Parameters:

element (QDomElement)
context (QgsReadWriteContext)

Return type:

Optional[QgsFeatureRenderer]

defaultSymbol(self) → QgsSymbol | None[source]¶

Returns the default symbol which will be rendered for any feature which does not have embedded symbology.