Subgroup: other

Class: QgsNullSymbolRenderer

class qgis.core.QgsNullSymbolRenderer

Bases: qgis._core.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.

New in version 2.16: Methods

capabilities Returns details about internals of this renderer.
checkLegendSymbolItem item in symbology was checked
clone
convertFromRenderer Creates a QgsNullSymbolRenderer from an existing renderer.
convertSymbolRotation
convertSymbolSizeScale
copyRendererData
create Creates a null renderer from XML element.
defaultRenderer return a new renderer - used by default in vector layers
dump
embeddedRenderer Returns the current embedded renderer (subrenderer) for this feature renderer.
filter If a renderer does not require all the features this method may be overridden and return an expression used as where clause.
filterNeedsGeometry Returns true if this renderer requires the geometry to apply the filter.
forceRasterRender Returns whether the renderer must render as a raster.
legendClassificationAttribute If supported by the renderer, return classification attribute for the use in legend
legendKeysForFeature Return legend keys matching a specified feature.
legendSymbolItemChecked items of symbology items in legend is checked
legendSymbolItems Returns a list of symbology items for the legend
legendSymbolItemsCheckable items of symbology items in legend should be checkable
load create a renderer from XML element
loadSld Create a new renderer according to the information contained in
modifyRequestExtent Allows for a renderer to modify the extent of a feature request prior to rendering
orderBy Get the order in which features shall be processed by this renderer.
orderByEnabled Returns whether custom ordering will be applied before features are processed by this renderer.
originalSymbolForFeature
originalSymbolsForFeature Equivalent of originalSymbolsForFeature() call
paintEffect Returns the current paint effect for the renderer.
renderFeature
renderFeatureWithSymbol
renderVertexMarker
renderVertexMarkerPolygon
renderVertexMarkerPolyline
save
setEmbeddedRenderer Sets an embedded renderer (subrenderer) for this feature renderer.
setForceRasterRender Sets whether the renderer should be rendered to a raster destination.
setLegendSymbolItem Sets the symbol to be used for a legend symbol item.
setOrderBy Define the order in which features shall be processed by this renderer.
setOrderByEnabled Sets whether custom ordering should be applied before features are processed by this renderer.
setPaintEffect Sets the current paint effect for the renderer.
setUsingSymbolLevels
setVertexMarkerAppearance set type and size of editing vertex markers for subsequent rendering
startRender Must be called when a new render cycle is started.
stopRender
symbolForFeature
symbols
symbolsForFeature Returns list of symbols used for rendering the feature.
toSld used from subclasses to create SLD Rule elements following SLD v1.1 specs
type
usedAttributes
usingSymbolLevels
willRenderFeature
writeSld create the SLD UserStyle element following the SLD v1.1 specs with the given name

Attributes

Filter
MoreSymbolsPerFeature
ScaleDependent
SymbolLevels
clone(self) → QgsFeatureRenderer
convertFromRenderer(renderer: QgsFeatureRenderer) → QgsNullSymbolRenderer

Creates a QgsNullSymbolRenderer from an existing renderer.

Parameters:renderer – renderer to convert from
Returns:a new renderer if the conversion was possible, otherwise None.
convertSymbolRotation()
convertSymbolSizeScale()
copyRendererData()
create(element: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer

Creates a null renderer from XML element.

Parameters:
  • element – DOM element
  • context – reading context
Returns:

new null symbol renderer

dump(self) → str
originalSymbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol
renderFeature(self, feature: QgsFeature, context: QgsRenderContext, layer: int = -1, selected: bool = False, drawVertexMarker: bool = False) → bool
renderFeatureWithSymbol()
renderVertexMarker()
renderVertexMarkerPolygon()
renderVertexMarkerPolyline()
save(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement
stopRender(self, context: QgsRenderContext)
symbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol
symbols(self, context: QgsRenderContext) → object
usedAttributes(self, context: QgsRenderContext) → Set[str]
willRenderFeature(self, feat: QgsFeature, context: QgsRenderContext) → bool