Os trechos de código desta página precisam das seguintes importações se você estiver fora do console do pyqgis:

from qgis.PyQt.QtGui import (
    QColor,
)

from qgis.PyQt.QtCore import Qt, QRectF

from qgis.core import (
    QgsVectorLayer,
    QgsPoint,
    QgsPointXY,
    QgsProject,
    QgsGeometry,
    QgsMapRendererJob,
)

from qgis.gui import (
    QgsMapCanvas,
    QgsVertexMarker,
    QgsMapCanvasItem,
    QgsRubberBand,
)

9. Usando a Tela do Mapa

O widget de tela Mapa é provavelmente o widget mais importante no QGIS, pois mostra o mapa composto de camadas de mapas sobrepostas e permite a interação com o mapa e as camadas. A tela sempre mostra uma parte do mapa definida pela extensão atual da tela. A interação é feita através do uso de ferramentas de mapa: existem ferramentas para panorâmica, zoom, identificação de camadas, medição, edição de vetores e outras. Semelhante a outros programas gráficos, sempre há uma ferramenta ativa e o usuário pode alternar entre as ferramentas disponíveis.

The map canvas is implemented with the QgsMapCanvas class in the qgis.gui module. The implementation is based on the Qt Graphics View framework. This framework generally provides a surface and a view where custom graphics items are placed and user can interact with them. We will assume that you are familiar enough with Qt to understand the concepts of the graphics scene, view and items. If not, please read the overview of the framework.

Sempre que o mapa for panorâmico, tem o zoom aumentado/diminuído (ou alguma outra ação que desencadeia uma atualização), o mapa é renderizado novamente na extensão atual. As camadas são renderizadas em uma imagem (usando a classe QgsMapRendererJob) e essa imagem é exibida na tela. A classe QgsMapCanvas classe também controla a atualização do mapa renderizado. Além deste item que atua como plano de fundo, pode haver mais itens de tela de mapa.

Os itens típicos da tela de mapa são rubber bands (usados ​​para medição, edição de vetor etc.) ou marcadores de vértice. Os itens de tela geralmente são usados ​​para fornecer feedback visual para as ferramentas de mapa; por exemplo, ao criar um novo polígono, a ferramenta de mapa cria um item de tela rubber band que mostra a forma atual do polígono. Todos os itens da tela de mapa são subclasses de QgsMapCanvasItem, que adiciona mais funcionalidade aos objetos básicos QGraphicsItem.

Para resumir, a arquitetura do mapa na tela são constituídas por três conceitos:

• tela do mapa — para visualização do mapa

• itens da tela de mapa — itens adicionais que podem ser mostrados na tela do mapa

• ferramentas de mapa — para interação com a tela do mapa

9.1. Incorporar o Mapa da Tela

A tela de mapa é um widget como qualquer outro widget Qt, portanto, usá-lo é tão simples quanto criar e mostrar.

canvas = QgsMapCanvas()
canvas.show()

Isso produz uma janela independente com tela de mapa. Também pode ser incorporado a um widget ou janela existente. Ao usar arquivos .ui e o Qt Designer, coloque um QWidget no formulário e promova-o para uma nova classe: defiina` QgsMapCanvas` como nome da classe e defina qgis.gui como arquivo de cabeçalho. O pyuic5 cuidará dele. Essa é uma maneira muito conveniente de incorporar a tela. A outra possibilidade é escrever manualmente o código para construir a tela do mapa e outros widgets (como filhos de uma janela ou caixa de diálogo principal) e criar um layout.

Por padrão, o mapa na tela tem fundo preto e não usa anti-aliasing. Para definir o fundo branco e permitir anti-aliasing para renderização suave

canvas.setCanvasColor(Qt.white)
canvas.enableAntiAliasing(True)

(Caso você esteja se perguntando, Qt vem do módulo PyQt.QtCore e Qt.white é uma das instâncias predefinidas do QColor).

Agora é hora de adicionar algumas camadas do mapa. Primeiro abriremos uma camada e a adicionaremos ao projeto atual. Em seguida, definiremos a extensão da tela e a lista de camadas para a tela.

vlayer = QgsVectorLayer('testdata/airports.shp', "Airports layer", "ogr")
if not vlayer.isValid():
    print("Layer failed to load!")

# add layer to the registry
QgsProject.instance().addMapLayer(vlayer)

# set extent to the extent of our layer
canvas.setExtent(vlayer.extent())

# set the map canvas layer set
canvas.setLayers([vlayer])

Depois de executar esses comandos, a tela deve mostrar a camada que você carregou.

9.2. Bandas raster e fazedor de vértices

Para mostrar alguns dados adicionais na parte superior do mapa na tela, use os itens da tela do mapa. É possível criar classes de item de tela personalizadas (abordadas abaixo), no entanto, existem duas classes úteis de itens de tela por conveniência: QgsRubberBand para desenhar polilinhas ou polígonos e QgsVertexMarker para pontos de desenho. Os dois trabalham com coordenadas do mapa, para que a forma seja movida/redimensionada automaticamente quando a tela for panorâmica ou ampliada.

Para mostrar uma polilinha:

r = QgsRubberBand(canvas, False)  # False = not a polygon
points = [QgsPoint(-100, 45), QgsPoint(10, 60), QgsPoint(120, 45)]
r.setToGeometry(QgsGeometry.fromPolyline(points), None)

Para mostrar o poligono

r = QgsRubberBand(canvas, True)  # True = a polygon
points = [[QgsPointXY(-100, 35), QgsPointXY(10, 50), QgsPointXY(120, 35)]]
r.setToGeometry(QgsGeometry.fromPolygonXY(points), None)

Note-se que aponta para polígono não é uma lista simples: na verdade, é uma lista de anéis contendo anéis lineares do polígono: primeiro anel é a borda externa, ainda mais (opcional) anéis correspondem aos buracos no polígono.

As Bandas Raster permitem alguma personalização, ou seja, para mudar sua cor e linha de largura

r.setColor(QColor(0, 0, 255))
r.setWidth(3)

Os itens da tela são vinculados à cena da tela. Para ocultá-los temporariamente (e mostrá-los novamente), use as combinações hide() e show(). Para remover completamente o item, você deve removê-lo da cena da tela

canvas.scene().removeItem(r)

(em C ++ é possível simplesmente apagar o item, no entanto, em Python `` del r`` seria apenas suprimir a referência eo objeto continuará a existir, uma vez que é de propriedade da tela)

Rubber band também pode ser usado para desenhar pontos, mas a classe QgsVertexMarker é mais adequada para isso (QgsRubberBand apenas desenha um retângulo ao redor do ponto desejado).

Você pode usar o marcador de vértice assim:

m = QgsVertexMarker(canvas)
m.setCenter(QgsPointXY(10,40))

Isto irá desenhar uma cruz vermelha na posição [10,45]. É possível personalizar o tipo de ícone, tamanho, cor e largura da caneta

m.setColor(QColor(0, 255, 0))
m.setIconSize(5)
m.setIconType(QgsVertexMarker.ICON_BOX) # or ICON_CROSS, ICON_X
m.setPenWidth(3)

Para ocultar temporariamente os marcadores de vértice e removê-los da tela, use os mesmos métodos usados ​​para rubber bands.

9.3. Usando Ferramentas de Mapas na Tela

O exemplo a seguir constrói uma janela que contém uma tela de mapa e ferramentas básicas de mapa para panorâmica e zoom do mapa. As ações são criadas para a ativação de cada ferramenta: as panôramicas são feitas com QgsMapToolPan, aumentando/diminuindo o zoom com algumas instâncias QgsMapToolZoom. As ações são definidas como verificáveis ​​e, posteriormente, atribuídas às ferramentas para permitir o manuseio automático do estado marcado/desmarcado das ações - quando uma ferramenta de mapa é ativada, sua ação é marcada como selecionada e a ação da ferramenta de mapa anterior é desmarcada. As ferramentas de mapa são ativadas usando o método setMapTool ().

from qgis.gui import *
from qgis.PyQt.QtWidgets import QAction, QMainWindow
from qgis.PyQt.QtCore import Qt

class MyWnd(QMainWindow):
    def __init__(self, layer):
        QMainWindow.__init__(self)

        self.canvas = QgsMapCanvas()
        self.canvas.setCanvasColor(Qt.white)

        self.canvas.setExtent(layer.extent())
        self.canvas.setLayers([layer])

        self.setCentralWidget(self.canvas)

        self.actionZoomIn = QAction("Zoom in", self)
        self.actionZoomOut = QAction("Zoom out", self)
        self.actionPan = QAction("Pan", self)

        self.actionZoomIn.setCheckable(True)
        self.actionZoomOut.setCheckable(True)
        self.actionPan.setCheckable(True)

        self.actionZoomIn.triggered.connect(self.zoomIn)
        self.actionZoomOut.triggered.connect(self.zoomOut)
        self.actionPan.triggered.connect(self.pan)

        self.toolbar = self.addToolBar("Canvas actions")
        self.toolbar.addAction(self.actionZoomIn)
        self.toolbar.addAction(self.actionZoomOut)
        self.toolbar.addAction(self.actionPan)

        # create the map tools
        self.toolPan = QgsMapToolPan(self.canvas)
        self.toolPan.setAction(self.actionPan)
        self.toolZoomIn = QgsMapToolZoom(self.canvas, False) # false = in
        self.toolZoomIn.setAction(self.actionZoomIn)
        self.toolZoomOut = QgsMapToolZoom(self.canvas, True) # true = out
        self.toolZoomOut.setAction(self.actionZoomOut)

        self.pan()

    def zoomIn(self):
        self.canvas.setMapTool(self.toolZoomIn)

    def zoomOut(self):
        self.canvas.setMapTool(self.toolZoomOut)

    def pan(self):
        self.canvas.setMapTool(self.toolPan)

Você pode tentar o código acima no editor de console do Python. Para chamar a janela da tela, adicione as seguintes linhas para instanciar a classe MyWnd. Eles renderizarão a camada atualmente selecionada na tela recém-criada

w = MyWnd(iface.activeLayer())
w.show()

9.3.1. Select a feature using QgsMapToolIdentifyFeature

You can use the map tool QgsMapToolIdentifyFeature for asking to the user to select a feature that will be sent to a callback function.

def callback(feature):
  """Code called when the feature is selected by the user"""
  print("You clicked on feature {}".format(feature.id()))

canvas = iface.mapCanvas()
feature_identifier = QgsMapToolIdentifyFeature(canvas)

# indicates the layer on which the selection will be done
feature_identifier.setLayer(vlayer)

# use the callback as a slot triggered when the user identifies a feature
feature_identifier.featureIdentified.connect(callback)

# activation of the map tool
canvas.setMapTool(feature_identifier)

9.4. Desenhar ferramenta de mapa personalizada

Você pode escrever suas ferramentas personalizadas, para implementar um comportamento personalizado nas ações executadas pelos usuários na tela.

As ferramentas de mapa devem herdar de QgsMapTool, classe ou qualquer classe derivada, e selecionadas como ferramentas ativas na tela usando o setMapTool () como já vimos.

Aqui está um exemplo de uma ferramenta de mapa que permite definir uma medida retangular, clicando e arrastando na tela. Quando o retângulo é definido, ele imprime coordena seu limite no console. Ele utiliza os elementos de banda de borracha descritos antes para mostrar o retângulo selecionado, uma vez que está a ser definida.

class RectangleMapTool(QgsMapToolEmitPoint):
  def __init__(self, canvas):
    self.canvas = canvas
    QgsMapToolEmitPoint.__init__(self, self.canvas)
    self.rubberBand = QgsRubberBand(self.canvas, True)
    self.rubberBand.setColor(Qt.red)
    self.rubberBand.setWidth(1)
    self.reset()

  def reset(self):
    self.startPoint = self.endPoint = None
    self.isEmittingPoint = False
    self.rubberBand.reset(True)

  def canvasPressEvent(self, e):
    self.startPoint = self.toMapCoordinates(e.pos())
    self.endPoint = self.startPoint
    self.isEmittingPoint = True
    self.showRect(self.startPoint, self.endPoint)

  def canvasReleaseEvent(self, e):
    self.isEmittingPoint = False
    r = self.rectangle()
    if r is not None:
      print("Rectangle:", r.xMinimum(),
            r.yMinimum(), r.xMaximum(), r.yMaximum()
           )

  def canvasMoveEvent(self, e):
    if not self.isEmittingPoint:
      return

    self.endPoint = self.toMapCoordinates(e.pos())
    self.showRect(self.startPoint, self.endPoint)

  def showRect(self, startPoint, endPoint):
    self.rubberBand.reset(QGis.Polygon)
    if startPoint.x() == endPoint.x() or startPoint.y() == endPoint.y():
      return

    point1 = QgsPoint(startPoint.x(), startPoint.y())
    point2 = QgsPoint(startPoint.x(), endPoint.y())
    point3 = QgsPoint(endPoint.x(), endPoint.y())
    point4 = QgsPoint(endPoint.x(), startPoint.y())

    self.rubberBand.addPoint(point1, False)
    self.rubberBand.addPoint(point2, False)
    self.rubberBand.addPoint(point3, False)
    self.rubberBand.addPoint(point4, True)    # true to update canvas
    self.rubberBand.show()

  def rectangle(self):
    if self.startPoint is None or self.endPoint is None:
      return None
    elif (self.startPoint.x() == self.endPoint.x() or \
          self.startPoint.y() == self.endPoint.y()):
      return None

      return QgsRectangle(self.startPoint, self.endPoint)

  def deactivate(self):
    QgsMapTool.deactivate(self)
    self.deactivated.emit()

9.5. Desenhar itens da tela do mapa

Aqui está um exemplo de um item de tela personalizado que desenha um círculo:

class CircleCanvasItem(QgsMapCanvasItem):
  def __init__(self, canvas):
    super().__init__(canvas)
    self.center = QgsPoint(0, 0)
    self.size   = 100

  def setCenter(self, center):
    self.center = center

  def center(self):
    return self.center

  def setSize(self, size):
    self.size = size

  def size(self):
    return self.size

  def boundingRect(self):
    return QRectF(self.center.x() - self.size/2,
      self.center.y() - self.size/2,
      self.center.x() + self.size/2,
      self.center.y() + self.size/2)

  def paint(self, painter, option, widget):
    path = QPainterPath()
    path.moveTo(self.center.x(), self.center.y());
    path.arcTo(self.boundingRect(), 0.0, 360.0)
    painter.fillPath(path, QColor("red"))


# Using the custom item:
item = CircleCanvasItem(iface.mapCanvas())
item.setCenter(QgsPointXY(200,200))
item.setSize(80)