Class: QgsNullSymbolRenderer¶
-
class
qgis.core.
QgsNullSymbolRenderer
¶ Bases:
QgsFeatureRenderer
Null symbol renderer. Renderer which draws no symbols for features by default, but allows for labeling and diagrams for the layer. Selected features will also be drawn with a default symbol.
Methods
- rtype
QgsFeatureRenderer
Creates a
QgsNullSymbolRenderer
from an existing renderer.Clones generic renderer data to another renderer.
Creates a null renderer from XML element.
- rtype
str
- 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
- param context
- param feature
- param context
- param context
- param feature
-
clone
(self) → QgsFeatureRenderer¶ - Return type
-
convertFromRenderer
(renderer: QgsFeatureRenderer) → QgsNullSymbolRenderer¶ Creates a
QgsNullSymbolRenderer
from an existing renderer.- Parameters
renderer (QgsFeatureRenderer) – renderer to convert from
- Return type
- Returns
a new renderer if the conversion was possible, otherwise
None
.
-
convertSymbolRotation
(symbol: QgsSymbol, field: str)¶ Note
this function is used to convert old rotations expressions to symbol level DataDefined angle
-
convertSymbolSizeScale
(symbol: QgsSymbol, method: QgsSymbol.ScaleMethod, field: str)¶ Note
this function is used to convert old sizeScale expressions to symbol level DataDefined size
-
copyRendererData
(self, destRenderer: QgsFeatureRenderer)¶ Clones generic renderer data to another renderer. Currently clones
Order By
Paint Effect
- Parameters
destRenderer – destination renderer for copied effect
-
create
(element: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer¶ Creates a null renderer from XML element.
- Parameters
element (QDomElement) – DOM element
context (QgsReadWriteContext) – reading context
- Return type
- Returns
new null symbol renderer
-
dump
(self) → str¶ - Return type
str
-
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: Union[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
-
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]
-
willRenderFeature
(self, feature: QgsFeature, context: QgsRenderContext) → bool¶ - Parameters
feature (QgsFeature) –
context (QgsRenderContext) –
- Return type
bool