Class: QgsFeatureRendererGenerator¶
- class qgis.core.QgsFeatureRendererGenerator¶
Bases:
sip.wrapper
An interface for objects which generate feature renderers for vector layers.
New in version 3.18:
Methods
Creates a new feature renderer to use when rendering a vector layer.
Returns a unique ID string identifying the renderer generator.
Returns a double value which dictates the stacking or z order level associated with the returned renderer.
- createRenderer(self) QgsFeatureRenderer ¶
Creates a new feature renderer to use when rendering a vector layer.
Caller takes ownership of the returned renderer.
- Return type
- id(self) str ¶
Returns a unique ID string identifying the renderer generator.
- Return type
str
- level(self) float ¶
Returns a double value which dictates the stacking or z order level associated with the returned renderer.
A value > 0 will always be rendered AFTER the normal renderer for a vector layer (i.e. the renderer will be drawn on top of the normal feature renderer), while a value < 0 will always be rendered BEFORE the normal renderer (i.e. the rendered features will be drawn below the normal feature renderer).
Since a layer may potentially have multiple extra renderers created by QgsFeatureRendererGenerator subclasses, the level will always be used to control the order that these renderers are drawn. A renderer with a lower
level()
return value will always be drawn before those with a higherlevel()
value.The default implementation returns 1.0, i.e. features will be rendered ABOVE the normal vector layer renderer.
Note
If two
QgsFeatureRendererGenerator
implementations return the samelevel()
value, then their ordering will be unpredictable.- Return type
float