Class: QgsRendererAbstractMetadata¶

Stores metadata about one renderer class.

Note

It’s necessary to implement createRenderer() function. In C++ you can use QgsRendererMetadata convenience class.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: createRenderer()

Class Hierarchy¶

Subclasses¶

QgsRendererMetadata

Convenience metadata class that uses static functions to create renderer and its widget.

Abstract Methods

createRenderer

Returns new instance of the renderer given the DOM element.

Methods

`icon`	Returns an icon representing the renderer.
`name`	Returns the unique name of the renderer.
`setIcon`	Sets an icon representing the renderer.
`visibleName`	Returns a friendly display name of the renderer.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsRendererAbstractMetadata. See the FAQ for more details.

`compatibleLayerTypes`	Returns flags indicating the types of layer the renderer is compatible with.
`createRendererFromSld`	Returns a new instance of the renderer, converted from an SLD XML element.
`createRendererWidget`	Returns new instance of settings widget for the renderer.

Attributes

`All`
`LineLayer`
`PointLayer`
`PolygonLayer`

class qgis.core.QgsRendererAbstractMetadata[source]¶

Bases: object

__init__(name: str | None, visibleName: str | None, icon: QIcon = QIcon())

Constructor for QgsRendererAbstractMetadata, with the specified name.

The visibleName argument gives a translated, user friendly string identifying the renderer type.

The icon argument can be used to specify an icon representing the renderer.

Parameters:

name (Optional[str])
visibleName (Optional[str])
icon (QIcon = QIcon())

__init__(a0: QgsRendererAbstractMetadata)

Parameters:: a0 (QgsRendererAbstractMetadata)

All = 7¶

class LayerType¶: Bases: int

class LayerTypes¶
class LayerTypes(f: QgsRendererAbstractMetadata.LayerTypes | QgsRendererAbstractMetadata.LayerType)
class LayerTypes(a0: QgsRendererAbstractMetadata.LayerTypes): Bases: object

LineLayer = 2¶

PointLayer = 1¶

PolygonLayer = 4¶

virtual compatibleLayerTypes(self) → QgsRendererAbstractMetadata.LayerTypes[source]¶

Returns flags indicating the types of layer the renderer is compatible with.

Return type:: QgsRendererAbstractMetadata.LayerTypes

abstract createRenderer(self, elem: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer | None[source]¶

Returns new instance of the renderer given the DOM element. Returns None on error. Pure virtual function: must be implemented in derived classes.

Parameters:

elem (QDomElement)
context (QgsReadWriteContext)

Return type:

Optional[QgsFeatureRenderer]

virtual createRendererFromSld(self, elem: QDomElement, geomType: Qgis.GeometryType) → QgsFeatureRenderer | None[source]¶

Returns a new instance of the renderer, converted from an SLD XML element.

Parameters:

elem (QDomElement)
geomType (Qgis.GeometryType)

Return type:

Optional[QgsFeatureRenderer]

virtual createRendererWidget(self, layer: QgsVectorLayer | None, style: QgsStyle | None, oldRenderer: QgsFeatureRenderer | None) → QgsRendererWidget | None[source]¶

Returns new instance of settings widget for the renderer. Returns None on error.

The oldRenderer argument may refer to previously used renderer (or it is None). If not None, it may be used to initialize GUI of the widget from the previous settings. The old renderer does not have to be of the same type as returned by createRenderer().

Parameters:

layer (Optional[QgsVectorLayer])
style (Optional[QgsStyle])
oldRenderer (Optional[QgsFeatureRenderer])

Return type:

Optional[QgsRendererWidget]

icon(self) → QIcon[source]¶

Returns an icon representing the renderer.

See also

setIcon()

Return type:: QIcon

name(self) → str[source]¶

Returns the unique name of the renderer. This value is not translated.

See also

visibleName()

Return type:: str

setIcon(self, icon: QIcon)[source]¶

Sets an icon representing the renderer.

See also

icon()

Parameters:: icon (QIcon)

visibleName(self) → str[source]¶

Returns a friendly display name of the renderer. This value is translated.

See also

name()

Return type:: str