Class: QgsSymbolRenderContext¶

class qgis.core.QgsSymbolRenderContext(c: QgsRenderContext, u: QgsUnitTypes.RenderUnit, opacity: float = 1, selected: bool = False, renderHints: Union[QgsSymbol.RenderHints, QgsSymbol.RenderHint] = 0, f: QgsFeature = None, fields: QgsFields = QgsFields(), mapUnitScale: QgsMapUnitScale = QgsMapUnitScale())¶

Bases: sip.wrapper

Constructor for QgsSymbolRenderContext

Parameters

c –
u –
opacity – value between 0 (fully transparent) and 1 (fully opaque)
selected – set to True if symbol should be drawn in a “selected” state
renderHints – flags controlling rendering behavior
f –
fields –

mapUnitScale –

Enums

Methods

`expressionContextScope`	This scope is always available when a symbol of this type is being rendered.
`feature`	Returns the current feature being rendered.
`fields`	Fields of the layer.
`geometryPartCount`	Part count of current geometry
`geometryPartNum`	Part number of current geometry
`mapUnitScale`	Deprecated since version Will: be removed in QGIS 4.0
`opacity`	Returns the opacity for the symbol.
`originalGeometryType`	Returns the geometry type for the original feature geometry being rendered.
`outputLineWidth`	Deprecated since version Use: the size conversion methods in QgsRenderContext instead.
`outputPixelSize`	Deprecated since version Use: the size conversion methods in QgsRenderContext instead.
`outputUnit`	Returns the output unit for the context.
`renderContext`	Returns a reference to the context’s render context.
`renderHints`	Returns the rendering hint flags for the symbol.
`selected`	Returns `True` if symbols should be rendered using the selected symbol coloring and style.
`setExpressionContextScope`	Set an expression scope for this symbol.
`setFeature`
`setGeometryPartCount`	Sets the part count of current geometry
`setGeometryPartNum`	Sets the part number of current geometry
`setMapUnitScale`	Deprecated since version Will: be removed in QGIS 4.0
`setOpacity`	Sets the `opacity` for the symbol.
`setOriginalGeometryType`	Sets the geometry type for the original feature geometry being rendered.
`setOriginalValueVariable`	Sets the original value variable value for data defined symbology
`setOutputUnit`	Sets the output unit for the context.
`setRenderHints`	Sets rendering hint flags for the symbol.
`setSelected`	Sets whether symbols should be rendered using the selected symbol coloring and style.

Signals

Attributes

expressionContextScope(self) → QgsExpressionContextScope¶

This scope is always available when a symbol of this type is being rendered.

Returns: An expression scope for details about this symbol

feature(self) → QgsFeature¶: Returns the current feature being rendered. This may be None.

fields(self) → QgsFields¶: Fields of the layer. Currently only available in startRender() calls to allow symbols with data-defined properties prepare the expressions (other times fields() returns an empty QgsFields object).

New in version 2.4.

geometryPartCount(self) → int¶: Part count of current geometry

New in version 2.16.

geometryPartNum(self) → int¶: Part number of current geometry

New in version 2.16.

mapUnitScale(self) → QgsMapUnitScale¶: Deprecated since version Will: be removed in QGIS 4.0

opacity(self) → float¶

Returns the opacity for the symbol.

Returns: opacity value between 0 (fully transparent) and 1 (fully opaque)