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

Отрисовка карты и печать

Существует два способа получить печатную карту из исходных данных: простой и быстрый используя QgsMapRenderer или создание и тщательная настройка компоновки используя QgsComposition и сопутствующие классы.

Простая отрисовка

Отрисовка нескольких слоёв с помощью QgsMapRenderer — создаётся объект для рисования (QImage, QPainter и др.), задаётся набор слоёв, охват, размер результата и выполняется рендеринг:

# create image
img = QImage(QSize(800,600), QImage.Format_ARGB32_Premultiplied)

# set image's background color
color = QColor(255,255,255)
img.fill(color.rgb())

# create painter
p = QPainter()
p.begin(img)
p.setRenderHint(QPainter.Antialiasing)

render = QgsMapRenderer()

# set layer set
lst = [ layer.getLayerID() ]  # add ID of every layer
render.setLayerSet(lst)

# set extent
rect = QgsRect(render.fullExtent())
rect.scale(1.1)
render.setExtent(rect)

# set output size
render.setOutputSize(img.size(), img.logicalDpiX())

# do the rendering
render.render(p)

p.end()

# save image
img.save("render.png","png")

Вывод с использованием компоновщика карт

Компоновщик карт это удобный инструмент для создания более сложных печатных карт, по сравнению с простой отрисовкой описанной выше. Используя компоновщик можно создавать составные компоновки, содержащие карты, подписи, легенду, таблицы и другие элементы, которые обычно присутсвуют на печатных картах. Готовую компоновку можно экспортировать в PDF, растровое изображение или сразу же распечатать на принтере.

Компоновщик состоит из множества классов. Все они являются частью библиотеки ядра. В QGIS присутствует удобный интерфейс пользователя для расстановки всех элементов, но он пока ещё не доступен через библиотеку графического интерфейса. Если вы не знакомы с Qt Graphics View framework, рекомендуем изучить документацию сейчас, потому что компоновщик основан на этом фреймворке.

Основным классом компоновщика является QgsComposition, который в свою очередь основан на QGraphicsScene. Создадим экземпляр этого класса:

mapRenderer = iface.mapCanvas().mapRenderer()
c = QgsComposition(mapRenderer)
c.setPlotStyle(QgsComposition.Print)

Обратите вниманием, что компоновка принимает в качестве параметра экземпляр QgsMapRenderer. Предполагается, что код выполняется в среде QGIS и поэтому используется рендер активной карты. Компоновка использует различные параметры рендера, и самое главное — набор слоёв карты и текущий охват. При использовании компоновщика в самостоятельном приложении необходимо создать свой собственный экземпляр рендера, как это показано в разделе выше, и передать его в компоновку.

К компоновке можно добавлять разные элементы (карту, подписи, ...) — все они являются потомками класса QgsComposerItem. В настоящее время доступны следующие элементы:

  • карта — этот элемент определяет положение карты. Так можно создать карту и растянуть её на весь лист:

    x, y = 0, 0
    w, h = c.paperWidth(), c.paperHeight()
    composerMap = QgsComposerMap(c, x,y,w,h)
    c.addItem(composerMap)
    
  • подпись — позволяет отображать подписи. Можно изменять шрифт, цвет, выравнивание и поля:

    composerLabel = QgsComposerLabel(c)
    composerLabel.setText("Hello world")
    composerLabel.adjustSizeToText()
    c.addItem(composerLabel)
    
  • легенда

    legend = QgsComposerLegend(c)
    legend.model().setLayerSet(mapRenderer.layerSet())
    c.addItem(legend)
    
  • масштабная линейка

    item = QgsComposerScaleBar(c)
    item.setStyle('Numeric') # optionally modify the style
    item.setComposerMap(composerMap)
    item.applyDefaultSize()
    c.addItem(item)
    
  • стрелка севера

  • изображение

  • фигура

  • таблица

По умолчанию только что созданные элементы компоновки имеют нулевое положение (левый верхний угол страницы) и нулевой размер. Положение и размер всегда задаюся в миллиметрах:

# set label 1cm from the top and 2cm from the left of the page
composerLabel.setItemPosition(20,10)
# set both label's position and size (width 10cm, height 3cm)
composerLabel.setItemPosition(20,10, 100, 30)

Вокруг каждого элемента по умолчанию рисуется рамка. Убрать её можно так:

composerLabel.setFrame(False)

Помимо создания элементов компоновки вручную QGIS поддерживает шаблоны компоновок, которые являются компоновками со всеми элементами, сохраненными в файл .qpt (формат XML). К сожалению, этот функционал пока ещё не доступен в API.

После того как компоновка готова (все элементы созданы и добавлены к компоновке), можно приступать к представлению результатов в растровой или векторной форме.

По умолчанию для вывода используется лист формата A4 и разрешение 300 DPI. При необходимости эти настройки можно изменить. Размер бумаги задаётся в миллиметрах:

c.setPaperSize(width, height)
c.setPrintResolution(dpi)

Вывод в растровое изображение

Следующий фрагмент кода показывает как вывести компоновку в растровое изображение:

dpi = c.printResolution()
dpmm = dpi / 25.4
width = int(dpmm * c.paperWidth())
height = int(dpmm * c.paperHeight())

# create output image and initialize it
image = QImage(QSize(width, height), QImage.Format_ARGB32)
image.setDotsPerMeterX(dpmm * 1000)
image.setDotsPerMeterY(dpmm * 1000)
image.fill(0)

# render the composition
imagePainter = QPainter(image)
sourceArea = QRectF(0, 0, c.paperWidth(), c.paperHeight())
targetArea = QRectF(0, 0, width, height)
c.render(imagePainter, targetArea, sourceArea)
imagePainter.end()

image.save("out.png", "png")

Вывод в формате PDF

Следующий пример иллюстрирует вывод компоновки в файл формата PDF:

printer = QPrinter()
printer.setOutputFormat(QPrinter.PdfFormat)
printer.setOutputFileName("out.pdf")
printer.setPaperSize(QSizeF(c.paperWidth(), c.paperHeight()), QPrinter.Millimeter)
printer.setFullPage(True)
printer.setColorMode(QPrinter.Color)
printer.setResolution(c.printResolution())

pdfPainter = QPainter(printer)
paperRectMM = printer.pageRect(QPrinter.Millimeter)
paperRectPixel = printer.pageRect(QPrinter.DevicePixel)
c.render(pdfPainter, paperRectPixel, paperRectMM)
pdfPainter.end()