Outdated version of the documentation. Find the latest one here.

Using Plugin Layers

Si votre extension utilise ses propres méthodes pour rendre la couche cartographique, écrire votre propre type de couche basé sur QgsPluginLayer pourrait être la meilleure façon de l’implémenter.

**À FAIRE : **
Check correctness and elaborate on good use cases for QgsPluginLayer, ...

Subclassing QgsPluginLayer

Below is an example of a minimal QgsPluginLayer implementation. It is an excerpt of the Watermark example plugin:

class WatermarkPluginLayer(QgsPluginLayer):


  def __init__(self):
    QgsPluginLayer.__init__(self, WatermarkPluginLayer.LAYER_TYPE, \
      "Watermark plugin layer")

  def draw(self, rendererContext):
    image = QImage("myimage.png")
    painter = rendererContext.painter()
    painter.drawImage(10, 10, image)
    return True

Methods for reading and writing specific information to the project file can also be added:

def readXml(self, node):

def writeXml(self, node, doc):

When loading a project containing such a layer, a factory class is needed:

class WatermarkPluginLayerType(QgsPluginLayerType):

  def __init__(self):
    QgsPluginLayerType.__init__(self, WatermarkPluginLayer.LAYER_TYPE)

  def createLayer(self):
    return WatermarkPluginLayer()

You can also add code for displaying custom information in the layer properties:

def showLayerProperties(self, layer):