Guide

From install to a published dashboard

Seven steps, in order. By the end you’ll have an interactive, cross-filtering dashboard living in your QGIS project — and optionally shared to the public gallery.

Install the plugin

QGIS Dashboard installs with no build step. Copy the plugins/qgis_dashboards folder from the repository into your QGIS profile’s plugins directory, then enable it under Plugins → Manage and Install Plugins.

# Windows
%APPDATA%\QGIS\QGIS3\profiles\default\python\plugins\

# Linux
~/.local/share/QGIS/QGIS3/profiles/default/python/plugins/

# macOS
~/Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins/

Works on QGIS 3.22 through 4.x (Qt5 and Qt6). A toolbar button and a Plugins menu entry open the dashboard window.

Prefer a zip? Grab the packaged release from the repository and install it via Install from ZIP.

Open the window and start a dashboard

Click the toolbar button to open the dashboard window. From the Start screen choose New Dashboard (or continue an existing one). You get a framed canvas — the page your dashboard is laid out on, and the exact region that exports.

The left icon rail is your toolkit: add elements, add pages, zoom, clear filters, save, and open Settings. A dashboard can hold several pages, each with its own tabs and its own cross-filter wiring.

Add and configure tiles

Press Add element and pick a tile type from the icon picker — indicator, chart, pivot, list, live map, selector, text, image or header. The tile drops onto the canvas with sensible defaults.

Right-click any tile for Configure… (bind it to a layer and a field), Tile appearance… (per-tile color/size overrides) and Connections… (its cross-filter wiring). Drag the top strip to move a tile; use the handles to resize. Tiles snap to the grid.

Wire the cross-filters

Open Connections… on a source tile (a chart, pivot, selector or the map) and tick which tiles it should filter. Selecting a value then re-queries every connected tile in real time.

Wiring is explicit and page-local: you decide the links, and they only connect tiles on the same page. Filtering never alters your project layers.

Theme, size and lock

Open Settings to theme the canvas — pick one of twelve presets or fine-tune colors, the chart palette and fonts — and to set the page size, corner radius, spacing and text sizes.

When you’re done arranging, flip the lock on the tab strip: Build mode moves and resizes tiles; Use mode locks the layout and turns interaction on, so clicks cross-filter and the map pans and identifies.

Export to a self-contained file

From the export menu, choose Export to HTML for a single self-contained index.html that opens offline by double-click, with cross-filtering reproduced in the browser. PNG and PDF export the exact page region too.

Publish to the public gallery

Publish to public sends your dashboard straight to this website’s gallery. The plugin exports the interactive HTML, renders a thumbnail, and commits both to the gallery repository in one step — your dashboard appears as a card at qgis.byzenterra.org/qdashboards/gallery within a minute.

1Create a fine-grained GitHub token scoped to only the gallery repo with Contents: read & write.
2Paste it into the Publish dialog (stored locally on your machine).
3Click Publish — you’ll get the public link when it’s live.

Re-publishing the same dashboard updates its existing gallery entry rather than creating a duplicate.

See the gallery