Class: QgsPluginLayerRegistry

A registry of plugin layers types.

QgsPluginLayerRegistry is not usually directly created, but rather accessed through QgsApplication.pluginLayerRegistry().

class qgis.core.QgsPluginLayerRegistry[source]

Bases: object

addPluginLayerType(self, pluginLayerType: QgsPluginLayerType | None) bool[source]

Add plugin layer type (take ownership) and return True on success

Parameters:

pluginLayerType (Optional[QgsPluginLayerType])

Return type:

bool

createLayer(self, typeName: str | None, uri: str | None = '') QgsPluginLayer | None[source]

Returns new layer if corresponding plugin has been found else returns None.

Note

parameter uri has been added in QGIS 2.10

Parameters:
  • typeName (Optional[str])

  • uri (Optional[str] = '')

Return type:

Optional[QgsPluginLayer]

pluginLayerType(self, typeName: str | None) QgsPluginLayerType | None[source]

Returns plugin layer type metadata or None if doesn’t exist

Parameters:

typeName (Optional[str])

Return type:

Optional[QgsPluginLayerType]

pluginLayerTypes(self) List[str][source]

List all known layer types

Return type:

List[str]

removePluginLayerType(self, typeName: str | None) bool[source]

Remove plugin layer type and return True on success

Parameters:

typeName (Optional[str])

Return type:

bool