Class: QgsSingleSymbolRenderer¶

A feature renderer which renders all features with the same symbol.

Class Hierarchy¶

Base classes¶

QgsFeatureRenderer

Abstract base class for all 2D vector feature renderers.

Methods

`dataDefinedSizeLegend`	Returns configuration of appearance of legend when using data-defined size for marker symbols.
`setDataDefinedSizeLegend`	Configures appearance of legend when renderer is configured to use data-defined size for marker symbols.
`setSymbol`	Sets the symbol which will be rendered for every feature.
`symbol`	Returns the symbol which will be rendered for every feature.

Static Methods

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

class qgis.core.QgsSingleSymbolRenderer[source]¶

Bases: QgsFeatureRenderer

__init__(symbol: QgsSymbol | None)

Constructor for QgsSingleSymbolRenderer.

The same symbol will be used to render every feature. Ownership of symbol is transferred to the renderer.

Parameters:: symbol (Optional[QgsSymbol])

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

Creates a new single symbol renderer from an existing renderer.

Return type:: Optional[QgsSingleSymbolRenderer]
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 single 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]

static createFromSld(element: QDomElement, geomType: Qgis.GeometryType) → QgsFeatureRenderer | None[source]¶

Creates a new single symbol renderer from an SLD element.

The geometry type for features to be rendered must be specified via the geomType argument.

The caller takes ownership of the returned renderer.

Parameters:

element (QDomElement)
geomType (Qgis.GeometryType)

Return type:

Optional[QgsFeatureRenderer]

dataDefinedSizeLegend(self) → QgsDataDefinedSizeLegend | None[source]¶

Returns configuration of appearance of legend when using data-defined size for marker symbols. Will return None if the functionality is disabled.

Return type:: Optional[QgsDataDefinedSizeLegend]

setDataDefinedSizeLegend(self, settings: QgsDataDefinedSizeLegend | None)[source]¶

Configures appearance of legend when renderer is configured to use data-defined size for marker symbols. This allows configuring which values (symbol sizes) should be shown in the legend, whether to display different symbol sizes collapsed in one legend node or separated across multiple legend nodes etc.

When renderer does not use data-defined size or does not use marker symbols, these settings will be ignored. Takes ownership of the passed settings objects. None is a valid input that disables data-defined size legend.

Parameters:: settings (Optional[QgsDataDefinedSizeLegend])

setSymbol(self, s: QgsSymbol | None)[source]¶

Sets the symbol which will be rendered for every feature. Ownership of the symbol is transferred to the renderer.