Subgroup: Single

Class: QgsSingleSymbolRenderer

class qgis.core.QgsSingleSymbolRenderer(symbol: QgsSymbol)

Bases: qgis._core.QgsFeatureRenderer

Methods

capabilities
checkLegendSymbolItem	item in symbology was checked
clone
convertFromRenderer	creates a QgsSingleSymbolRenderer from an existing renderer.
convertSymbolRotation
convertSymbolSizeScale
copyRendererData
create	create renderer from XML element
createFromSld
dataDefinedSizeLegend	Returns configuration of appearance of legend when using data-defined size for marker symbols.
defaultRenderer	return a new renderer - used by default in vector layers
dump
embeddedRenderer	Returns the current embedded renderer (subrenderer) for this feature renderer.
filter	If a renderer does not require all the features this method may be overridden and return an expression used as where clause.
filterNeedsGeometry	Returns true if this renderer requires the geometry to apply the filter.
forceRasterRender	Returns whether the renderer must render as a raster.
legendClassificationAttribute	If supported by the renderer, return classification attribute for the use in legend
legendKeysForFeature
legendSymbolItemChecked	items of symbology items in legend is checked
legendSymbolItems
legendSymbolItemsCheckable	items of symbology items in legend should be checkable
load	create a renderer from XML element
loadSld	Create a new renderer according to the information contained in
modifyRequestExtent	Allows for a renderer to modify the extent of a feature request prior to rendering
orderBy	Get the order in which features shall be processed by this renderer.
orderByEnabled	Returns whether custom ordering will be applied before features are processed by this renderer.
originalSymbolForFeature
originalSymbolsForFeature	Equivalent of originalSymbolsForFeature() call
paintEffect	Returns the current paint effect for the renderer.
renderFeature	Render a feature using this renderer in the given context.
renderFeatureWithSymbol
renderVertexMarker
renderVertexMarkerPolygon
renderVertexMarkerPolyline
save
setDataDefinedSizeLegend	Configures appearance of legend when renderer is configured to use data-defined size for marker symbols.
setEmbeddedRenderer	Sets an embedded renderer (subrenderer) for this feature renderer.
setForceRasterRender	Sets whether the renderer should be rendered to a raster destination.
setLegendSymbolItem
setOrderBy	Define the order in which features shall be processed by this renderer.
setOrderByEnabled	Sets whether custom ordering should be applied before features are processed by this renderer.
setPaintEffect	Sets the current paint effect for the renderer.
setSymbol
setUsingSymbolLevels
setVertexMarkerAppearance	set type and size of editing vertex markers for subsequent rendering
startRender
stopRender
symbol
symbolForFeature
symbols
symbolsForFeature	Returns list of symbols used for rendering the feature.
toSld
type
usedAttributes
usingSymbolLevels
willRenderFeature	Returns whether the renderer will render a feature or not.
writeSld	create the SLD UserStyle element following the SLD v1.1 specs with the given name

Attributes

Filter
MoreSymbolsPerFeature
ScaleDependent
SymbolLevels

capabilities(self) → QgsFeatureRenderer.Capabilities

clone(self) → QgsSingleSymbolRenderer

convertFromRenderer(renderer: QgsFeatureRenderer) → QgsSingleSymbolRenderer

creates a QgsSingleSymbolRenderer from an existing renderer.

Returns:a new renderer if the conversion was possible, otherwise 0.

New in version 2.5.

convertSymbolRotation()

convertSymbolSizeScale()

copyRendererData()

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

create renderer from XML element

createFromSld(element: QDomElement, geomType: QgsWkbTypes.GeometryType) → 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.

dump(self) → str

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

legendSymbolItems(self) → object

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

renderFeatureWithSymbol()

renderVertexMarker()

renderVertexMarkerPolygon()

renderVertexMarkerPolyline()

save(self, doc: QDomDocument, context: QgsReadWriteContext) → 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.

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

setSymbol(self, s: QgsSymbol)

startRender(self, context: QgsRenderContext, fields: QgsFields)

stopRender(self, context: QgsRenderContext)

symbol(self) → QgsSymbol

symbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol

symbols(self, context: QgsRenderContext) → object

toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, str] = {})

usedAttributes(self, context: QgsRenderContext) → Set[str]