Docs in progress for ‘QGIS testing’. Visit https://docs.qgis.org/3.4 for QGIS 3.4 docs and translations.

Creating a Report

What is?

This section will help you set up an automatic report in QGIS. By definition a GIS report is a document containing information organized in a narrative, graphic, maps, or tabular form, prepared on ad hoc, periodic, recurring, regular, or as required basis. Reports may refer to specific periods, events, occurrences, or subjects, locations, and may be communicated or presented in oral or written form. The reports in QGIS will allow the users to output their GIS projects in a simple, quick and structured way.

Get started

Reports menu is an extension of Print Layout. This functionality can be found in Project ‣ New Report or inside of Project ‣ Layout Manager.

In the Layout Manager dialog the report can be created through New from template and select the dropdown option Empty Report and hitting Create… button.

For this example, we use some administrative boundaries, populated places, ports and airports from dataset of Natural Earth.

../../../_images/project-1.png

Using the Project ‣ New Report command, we then create a new blank report. Initially, there’s not much to look at – the dialog which is displayed looks much like the print layout designer, except for the new Report Organizer panel shown on the left:

../../../_images/report-2.png

Layout Report Workspace

QGIS reports can consist of multiple, nested sections. In our new blank report we initially have only the main report section. The only options present for this report section is Include report header or Include report footer. If we enable these options, the header will be included as the very first page (or pages… — individual parts of reports can be multi-page if desired) in the report, and the footer would be the last page. Let’s go ahead and enable the header, and hit the Edit button next to it:

../../../_images/report_header.png

A few things happen as a result. Firstly, an edit pencil is now shown next to the Report section in the Report Organizer, indicating that the report section is currently being edited in the designer. We also see a new blank page shown in the designer itself, with the small Report Header title. In QGIS reports, every component of the report is made up of individual layouts. They can be created and modified using the exact same tools as are available for standard print layouts – so you can use any desired combination of labels, pictures, maps, tables, etc. Let’s add some items to our report header to demonstrate:

../../../_images/header.png

We’ll also create a simple footer for the report, by checking the Include report footer option and hitting Edit.

../../../_images/footer.png

Before proceeding further, let’s export this report and see what we get. Exporting is done from the Report menu – in this case we select Export Report as PDF to render the whole report to a PDF file. Here’s the not-very-impressive result – a two page PDF consisting of our header and footer:

../../../_images/headerfooter.png

Let’s make things more interesting. By hitting the signPlus Add Static Layout Section button in the Report Organizer, we’re given a choice of new sections to add to our report.

../../../_images/add_section.png

There are two options: Add Static Layout Section and a Field Group Section. The Add Static Layout Section is a single, static body layout. This can be used to embed static layouts mid-way through a report. Alternatively, a Field Group Section repeats its body layout for every feature in a layer. The features are sorted by the selected grouping feature (with an option for ascending/descending sort). If a field group section has child sections (e.g. another field group section with a different field, then only features with unique values for the group feature are iterated over. This allows nested reports with different information.

For now we’ll add a Field Group to our report. At its most basic level, you can think of a Field Group Section as the equivalent of a print atlas. You select a layer to iterate over, and the report will insert a section for each feature found. Selecting the new Field Group Section reveals a number of new related settings:

../../../_images/field_group.png

In this case we’ve setup our Field Group so that we iterate over all the states from the Admin Level 1 layer, using the values from the adm1name field. The same options for header and footer are present, together with a new option to include a body for this section. We’ll do that, and edit the body:

../../../_images/edit_group_body.png

We’ve setup this body with a map (set to follow the current report feature – just like how a map item in an atlas can follow the current atlas feature), and a label showing the state’s name. If we went ahead and exported our report now, we’d get something like this:

../../../_images/report1.png

First, the report header, then a page for each state, and finally the report footer. So more or less an atlas, but with a header and footer page. Let’s make things more interesting by adding a subsection to our state group. We do this by first selecting the state field group in the organizer, then hitting the signPlus Field Group Section button and adding a new Field Group Section:

../../../_images/subsection.png

When a Field Group Section is iterating over its features, it will automatically filter these features to match the feature attributes from its parent groups. In this case, the subsection we added will iterate over a Populated Places layer, including a body section for each place encountered. The magic here is that the Populated Places layer has an attribute named adm1name, tagging each place with the state it’s contained within (if you’re lucky your data will already be structured like this – if not, run the Processing Join Attributes by Location algorithm and create your own field). When we export this report, QGIS will grab the first state from the Admin Level 1 layer, and then iterate over all the Populated Places with a matching adm1name value. Here’s what we get:

../../../_images/report3.png

Here we created a basic body for the Populated Places group, including a map of the place and a table of some place attributes. So our report is now a report header, a page for each state followed by a page for every populated place within that state, and finally the report footer. If we were to add a header for the Populated Places group, it would be included just before listing the populated places for each state:

../../../_images/report4.png

Similarly, a footer for the Populated Places group would be inserted after the final place for each state is included.

In addition to nested subsections, subsections in a report can also be included consecutively. If we add a second subsection to the Admin Level 1 group for Airports, then our report will first list ALL the populated places for each state, followed by all the airports within that state, before proceeding to the next state. In this case our report would be structured like this:

../../../_images/report_consec.png

Report Output

The key point here is that our Airports group is a subsection of the Admin Level 1 group – not the Populated Places group. Here’s what our report could look like now:

../../../_images/report5.png

Combining nested and consecutive sections, together with section headers and footers allows for tons of flexibility. For instance, in the below report we add another field group as a child of the main report for the :guilabel`Ports` layer. Now, after listing the states together with their populated places and airports, we’ll get a summary list of all the ports in the region:

../../../_images/report_flex.png

This results in the last part of our report exporting as:

../../../_images/ports.png

Export settings

Whenever you export a report, there is a selection of export settings QGIS needs to check in order to return the most appropriate output. As you can start to imagine, reports in QGIS are extremely powerful and flexible!

Note

When you are exporting a report to the available formats please choose the options (Print, SVG, Image, PDF) that have the labels saying Export Report as… otherwise you will print the current active map.

../../../_images/export_options_reports.png

The current information was adapted from the blog of North Road, Exploring Reports in QGIS 3.0 - the Ultimate Guide!