Class: QgsEmbeddedSymbolRenderer¶
- class qgis.core.QgsEmbeddedSymbolRenderer¶
Bases:
QgsFeatureRenderer
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.New in version 3.20.
QgsEmbeddedSymbolRenderer(defaultSymbol:
QgsSymbol
) Constructor for QgsEmbeddedSymbolRenderer.The
defaultSymbol
will be used to render any feature without embedded symbology. Ownership ofdefaultSymbol
is transferred to the renderer.Methods
- rtype:
QgsFeatureRenderer.Capabilities
- rtype:
QgsEmbeddedSymbolRenderer
Creates a
QgsEmbeddedSymbolRenderer
from an existingrenderer
.Creates a new embedded symbol renderer from an XML
element
, using the supplied read/writecontext
.Returns the default symbol which will be rendered for any feature which does not have embedded symbology.
- param feature:
- param feature:
Render the
feature
with thesymbol
usingcontext
.render editing vertex marker at specified point
render editing vertex marker for a polygon
render editing vertex marker for a polyline
- param doc:
Saves generic renderer data into the specified
element
.Sets the default
symbol
which will be rendered for any feature which does not have embedded symbology.- param context:
- param context:
- param feature:
- param context:
- param context:
- rtype:
bool
- capabilities(self) QgsFeatureRenderer.Capabilities ¶
- Return type:
- clone(self) QgsEmbeddedSymbolRenderer ¶
- Return type:
- convertFromRenderer(renderer: QgsFeatureRenderer) QgsEmbeddedSymbolRenderer ¶
Creates a
QgsEmbeddedSymbolRenderer
from an existingrenderer
.- Return type:
- Returns:
a new renderer if the conversion was possible, otherwise
None
.- Parameters:
renderer (QgsFeatureRenderer) –
- convertSymbolRotation(symbol: QgsSymbol, field: str)¶
Note
this function is used to convert old rotations expressions to symbol level DataDefined angle
- convertSymbolSizeScale(symbol: QgsSymbol, method: Qgis.ScaleMethod, field: str)¶
Note
this function is used to convert old sizeScale expressions to symbol level DataDefined size
- create(element: QDomElement, context: QgsReadWriteContext) QgsFeatureRenderer ¶
Creates a new embedded symbol renderer from an XML
element
, using the supplied read/writecontext
.The caller takes ownership of the returned renderer.
- Parameters:
element (QDomElement) –
context (QgsReadWriteContext) –
- Return type:
- defaultSymbol(self) QgsSymbol ¶
Returns the default symbol which will be rendered for any feature which does not have embedded symbology.
See also
- Return type:
- originalSymbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) QgsSymbol ¶
- Parameters:
feature (QgsFeature) –
context (QgsRenderContext) –
- Return type:
- renderFeature(self, feature: QgsFeature, context: QgsRenderContext, layer: int = -1, selected: bool = False, drawVertexMarker: bool = False) bool ¶
- Parameters:
feature (QgsFeature) –
context (QgsRenderContext) –
layer (int = -1) –
selected (bool = False) –
drawVertexMarker (bool = False) –
- Return type:
bool
- renderFeatureWithSymbol(self, feature: QgsFeature, symbol: QgsSymbol, context: QgsRenderContext, layer: int, selected: bool, drawVertexMarker: bool)¶
Render the
feature
with thesymbol
usingcontext
. Uselayer
to specify the symbol layer,selected
to specify if it should be rendered as selected anddrawVertexMarker
to specify if vertex markers should be rendered.
- renderVertexMarker(self, pt: QPointF | QPoint, context: QgsRenderContext)¶
render editing vertex marker at specified point
- renderVertexMarkerPolygon(self, pts: QPolygonF, rings: Iterable[QPolygonF], context: QgsRenderContext)¶
render editing vertex marker for a polygon
- renderVertexMarkerPolyline(self, pts: QPolygonF, context: QgsRenderContext)¶
render editing vertex marker for a polyline
- save(self, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
- Parameters:
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type:
QDomElement
- saveRendererData(self, doc: QDomDocument, element: QDomElement, context: QgsReadWriteContext)¶
Saves generic renderer data into the specified
element
.This method should be called in a subclass’
save()
implementation in order to store all common base class properties in the DOMelement
.New in version 3.22.
- setDefaultSymbol(self, symbol: QgsSymbol)¶
Sets the default
symbol
which will be rendered for any feature which does not have embedded symbology.Ownership of
symbol
is transferred to the renderer.See also
- Parameters:
symbol (QgsSymbol) –
- startRender(self, context: QgsRenderContext, fields: QgsFields)¶
- Parameters:
context (QgsRenderContext) –
fields (QgsFields) –
- stopRender(self, context: QgsRenderContext)¶
- Parameters:
context (QgsRenderContext) –
- symbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) QgsSymbol ¶
- Parameters:
feature (QgsFeature) –
context (QgsRenderContext) –
- Return type:
- symbols(self, context: QgsRenderContext) List[QgsSymbol] ¶
- Parameters:
context (QgsRenderContext) –
- Return type:
List[QgsSymbol]
- usedAttributes(self, context: QgsRenderContext) Set[str] ¶
- Parameters:
context (QgsRenderContext) –
- Return type:
Set[str]
- usesEmbeddedSymbols(self) bool ¶
- Return type:
bool