Class: QgsSingleSymbolRenderer¶
- class qgis.core.QgsSingleSymbolRenderer(symbol: QgsSymbol)¶
Bases:
QgsFeatureRenderer
Constructor for QgsSingleSymbolRenderer.
The same
symbol
will be used to render every feature. Ownership ofsymbol
is transferred to the renderer.Methods
- param visitor:
- rtype:
QgsFeatureRenderer.Capabilities
- rtype:
QgsSingleSymbolRenderer
Creates a new single symbol renderer from an existing
renderer
.Creates a new single symbol renderer from an XML
element
, using the supplied read/writecontext
.Creates a new single symbol renderer from an SLD
element
.Returns configuration of appearance of legend when using data-defined size for marker symbols.
- rtype:
str
- param key:
- param feature:
- rtype:
List[QgsLegendSymbolItem]
- 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
.Configures appearance of legend when renderer is configured to use data-defined size for marker symbols.
- param key:
Sets the symbol which will be rendered for every feature.
- param context:
- param context:
Returns the symbol which will be rendered for every feature.
- param feature:
- param context:
- param doc:
- param context:
- accept(self, visitor: QgsStyleEntityVisitorInterface) bool ¶
- Parameters:
visitor (QgsStyleEntityVisitorInterface)
- Return type:
bool
- capabilities(self) QgsFeatureRenderer.Capabilities ¶
- Return type:
- clone(self) QgsSingleSymbolRenderer ¶
- Return type:
- convertFromRenderer(renderer: QgsFeatureRenderer) QgsSingleSymbolRenderer ¶
Creates a new single symbol renderer from an existing
renderer
.- 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 single 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:
- createFromSld(element: QDomElement, geomType: Qgis.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 (Qgis.GeometryType)
- Return type:
- dataDefinedSizeLegend(self) QgsDataDefinedSizeLegend ¶
Returns configuration of appearance of legend when using data-defined size for marker symbols. Will return
None
if the functionality is disabled.- Return type:
- dump(self) str ¶
- Return type:
str
- legendKeyToExpression(self, key: str, layer: QgsVectorLayer) Tuple[str, bool] ¶
- Parameters:
key (str)
layer (QgsVectorLayer)
- Return type:
Tuple[str, bool]
- legendKeysForFeature(self, feature: QgsFeature, context: QgsRenderContext) Set[str] ¶
- Parameters:
feature (QgsFeature)
context (QgsRenderContext)
- Return type:
Set[str]
- legendSymbolItems(self) List[QgsLegendSymbolItem] ¶
- Return type:
List[QgsLegendSymbolItem]
- originalSymbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) QgsSymbol ¶
- Parameters:
feature (QgsFeature)
context (QgsRenderContext)
- Return type:
- 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 | float, 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
.Added in version 3.22.
- 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.
None
is a valid input that disables data-defined size legend.- Parameters:
settings (QgsDataDefinedSizeLegend)
- setSymbol(self, s: QgsSymbol)¶
Sets the symbol which will be rendered for every feature. Ownership of the symbol is transferred to the renderer.
See also
- Parameters:
s (QgsSymbol)
- startRender(self, context: QgsRenderContext, fields: QgsFields)¶
- Parameters:
context (QgsRenderContext)
fields (QgsFields)
- stopRender(self, context: QgsRenderContext)¶
- Parameters:
context (QgsRenderContext)
- symbol(self) QgsSymbol ¶
Returns the symbol which will be rendered for every feature.
See also
- Return type:
- 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]
- toSld(self, doc: QDomDocument, element: QDomElement, props: Dict[str, Any] = {})¶
- Parameters:
doc (QDomDocument)
element (QDomElement)
props (Dict[str)
- usedAttributes(self, context: QgsRenderContext) Set[str] ¶
- Parameters:
context (QgsRenderContext)
- Return type:
Set[str]