Class: QgsSingleSymbolRenderer¶

class qgis.core.QgsSingleSymbolRenderer(symbol: QgsSymbol)¶

Bases: QgsFeatureRenderer

Constructor for QgsSingleSymbolRenderer.

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

Parameters: symbol –

capabilities(self) → QgsFeatureRenderer.Capabilities¶

Return type: QgsFeatureRenderer.Capabilities

clone(self) → QgsSingleSymbolRenderer¶

Return type: QgsSingleSymbolRenderer

convertFromRenderer(renderer: QgsFeatureRenderer) → QgsSingleSymbolRenderer¶

Creates a new single symbol renderer from an existing renderer.

Return type: QgsSingleSymbolRenderer
Returns: a new renderer if the conversion was possible, otherwise None.

New in version 2.5.

Parameters: renderer (QgsFeatureRenderer) –

convertSymbolRotation()¶

convertSymbolSizeScale()¶

copyRendererData()¶

create(element: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer¶

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

QgsFeatureRenderer

createFromSld(element: QDomElement, geomType: QgsWkbTypes.GeometryType) → QgsFeatureRenderer¶

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 (QgsWkbTypes.GeometryType) –

Return type

QgsFeatureRenderer

dataDefinedSizeLegend(self) → QgsDataDefinedSizeLegend¶

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

New in version 3.0.

Return type: QgsDataDefinedSizeLegend

dump(self) → str¶

Return type: str

legendKeysForFeature(self, feature: QgsFeature, context: QgsRenderContext) → Set[str]¶

Parameters

feature (QgsFeature) –
context (QgsRenderContext) –

Return type

Set[str]

legendSymbolItems(self) → object¶

Return type: object

originalSymbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol¶

Parameters

feature (QgsFeature) –
context (QgsRenderContext) –

Return type

QgsSymbol

renderFeatureWithSymbol()¶

renderVertexMarker()¶

renderVertexMarkerPolygon()¶

renderVertexMarkerPolyline()¶

save(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement¶

Parameters

doc (QDomDocument) –
context (QgsReadWriteContext) –

Return type

QDomElement

setDataDefinedSizeLegend(self, settings: QgsDataDefinedSizeLegend)¶

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. Null pointer is a valid input that disables data-defined size legend.

New in version 3.0.

Parameters: settings (QgsDataDefinedSizeLegend) –

setLegendSymbolItem(self, key: str, symbol: QgsSymbol)¶

Parameters

key (str) –
symbol (QgsSymbol) –

setSymbol(self, s: QgsSymbol)¶

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