Class: QgsRendererAbstractMetadata¶
- class qgis.core.QgsRendererAbstractMetadata¶
Bases:
sip.wrapper
Stores metadata about one renderer class.
Note
It’s necessary to implement
createRenderer()
function. In C++ you can useQgsRendererMetadata
convenience class.QgsRendererAbstractMetadata(name: str, visibleName: str, icon: QIcon = QIcon()) Constructor for
QgsRendererAbstractMetadata
, with the specifiedname
.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.QgsRendererAbstractMetadata(
QgsRendererAbstractMetadata
)Methods
Returns flags indicating the types of layer the renderer is compatible with.
Returns new instance of the renderer given the DOM element.
- param elem
Returns new instance of settings widget for the renderer.
Returns an icon representing the renderer.
Returns the unique name of the renderer.
Sets an
icon
representing the renderer.Returns a friendly display name of the renderer.
Attributes
- All = 7¶
- class LayerType¶
Bases:
int
- class LayerTypes¶
- class LayerTypes(Union[QgsRendererAbstractMetadata.LayerTypes, QgsRendererAbstractMetadata.LayerType])
- class LayerTypes(QgsRendererAbstractMetadata.LayerTypes)
Bases:
sip.wrapper
- LineLayer = 2¶
- PointLayer = 1¶
- PolygonLayer = 4¶
- compatibleLayerTypes(self) QgsRendererAbstractMetadata.LayerTypes ¶
Returns flags indicating the types of layer the renderer is compatible with.
New in version 2.16.
- Return type
- createRenderer(self, elem: QDomElement, context: QgsReadWriteContext) QgsFeatureRenderer ¶
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
- createRendererFromSld(self, elem: QDomElement, geomType: QgsWkbTypes.GeometryType) QgsFeatureRenderer ¶
- Parameters
elem (QDomElement) –
geomType (QgsWkbTypes.GeometryType) –
- Return type
- createRendererWidget(self, layer: QgsVectorLayer, style: QgsStyle, oldRenderer: QgsFeatureRenderer) QgsRendererWidget ¶
Returns new instance of settings widget for the renderer. Returns
None
on error.The
oldRenderer
argument may refer to previously used renderer (or it isNone
). If notNone
, 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 bycreateRenderer()
.- Parameters
layer (QgsVectorLayer) –
style (QgsStyle) –
oldRenderer (QgsFeatureRenderer) –
- Return type
- name(self) str ¶
Returns the unique name of the renderer. This value is not translated.
See also
- Return type
str
- setIcon(self, icon: QIcon)¶
Sets an
icon
representing the renderer.See also
- Parameters
icon (QIcon) –