Skip to content

Commit fd8477f

Browse files
authored
Updated dashboards (#449)
* Updated dashboards * formatting fixes
1 parent 759dc75 commit fd8477f

1 file changed

Lines changed: 283 additions & 50 deletions

File tree

docs/dashboards.md

Lines changed: 283 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,15 @@ description: Build custom dashboards in Plane to visualize project metrics.
55

66
# Dashboards <Badge type="info" text="Pro" />
77

8-
Dashboards in Plane give you a bird's-eye view of your projects through customizable visualizations. They help you monitor progress, identify bottlenecks, and make data-driven decisions without diving into individual projects.
8+
Dashboards are customizable data visualization spaces where you build charts, metrics, and tables from your work item data. Each dashboard is a canvas of **widgets** — individual visualizations you configure independently — arranged on a responsive grid.
99

10-
<div style="position: relative; padding-bottom: calc(56.67989417989418% + 41px); height: 0; width: 100%">
10+
![Dashboards](https://media.docs.plane.so/dashboards/dashboards.webp#hero)
11+
12+
Dashboards do not change any data. They are read-only lenses that aggregate issue data from one or more projects in your workspace and render it as charts or numbers. Every time you open a dashboard, Plane recomputes the data live from the current state of your work items.
13+
14+
Dashboards are workspace-scoped. They are not tied to a single project — each dashboard draws data from a set of projects you choose, which means one dashboard can show work across an entire organization.
15+
16+
<!-- <div style="position: relative; padding-bottom: calc(56.67989417989418% + 41px); height: 0; width: 100%">
1117
<iframe
1218
src="https://demo.arcade.software/nWdHtHinGVMWjMmaTMGj?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true"
1319
frameborder="0"
@@ -19,95 +25,265 @@ Dashboards in Plane give you a bird's-eye view of your projects through customiz
1925
title="Set up your workspace"
2026
></iframe>
2127
</div>
28+
-->
2229

23-
## Create Dashboard
30+
## Widgets
2431

25-
![Create Dashboard](https://media.docs.plane.so/dashboards/create-new-dashboard.webp#hero)
32+
A widget is a single chart or metric panel on a dashboard. You configure each widget
33+
independently with its own chart type, data axes, grouping, and filters. Widgets sit on a
34+
shared grid and can be resized and repositioned freely.
2635

27-
To create a new dashboard:
36+
Every widget answers a question of the form: _"For these work items, grouped by X, what is the
37+
count/metric of Y?"_
38+
39+
## Create a dashboard
40+
41+
![Create Dashboard](https://media.docs.plane.so/dashboards/create-new-dashboard.webp#hero)
2842

2943
1. Navigate to the **Dashboards** section in the left sidebar.
3044
2. Click the **Add dashboard** button in the top-right corner.
3145
3. Give your dashboard a descriptive name (e.g., `Project Analytics Dashboard` or `Workload by Team`)
32-
4. Choose which projects to include in your dashboard.
33-
5. Click **Create dashboard** to finish.
46+
4. Under **Projects**, select one or more projects whose issues this dashboard should draw
47+
data from. All widgets on this dashboard can only see issues from these projects.
48+
5. Optionally set **filters** to restrict the base work item pool for all widgets.
49+
6. Click **Create dashboard** to finish.
3450

35-
## Add Widgets
51+
## Add widgets to a dashboard
3652

3753
Once you've created a dashboard, it's time to add widgets. Widgets are visualization components that display your project data in different formats.
3854

3955
![Add Widget](https://media.docs.plane.so/dashboards/add-widget.webp#hero)
4056

41-
To add a widget:
57+
1. Open a dashboard.
58+
2. Click **Add widget** in the toolbar.
59+
3. In the widget type selector, choose a chart type and model.
60+
4. The widget appears on the grid at the next available position.
61+
5. The configuration sidebar opens automatically — configure the widget's axes, metrics,
62+
and filters (see below).
63+
6. Click **Save** or close the sidebar.
4264

43-
1. Click the **+ Add widget** button.
44-
2. Choose a [widget type](/dashboards#widget-types).
45-
3. Configure your widget with the specific data you want to display.
46-
4. Name your widget to reflect what it shows.
47-
5. Position it on your dashboard by dragging it
65+
## Widget types and models
4866

49-
### Widget types
67+
Each widget type supports one or more **models** — variations that change how the data series
68+
is structured and displayed.
5069

51-
![Dashboards](https://media.docs.plane.so/dashboards/dashboards.webp#hero)
70+
### Bar chart
71+
72+
A bar chart plots one value per group as a rectangular bar. Bars can run vertically
73+
(categories on the x-axis) or horizontally (categories on the y-axis). It is the most
74+
versatile chart type for comparing values across discrete categories — states, assignees,
75+
priorities, labels, and so on.
76+
77+
**Basic**
78+
79+
One bar per group. You pick a single color for all bars. Best used when each group is a
80+
distinct, non-overlapping category and you want a straightforward count or metric
81+
comparison. Example: number of work items per assignee, or number of work items per priority.
82+
83+
**Stacked** <Badge type="tip" text="Business" />
84+
85+
Each bar is divided into colored sub-segments, one per sub-group value. The full bar height
86+
represents the total for that group; the segments show how it breaks down. Best used when
87+
you want to see both the total and the composition. Requires a group-by dimension in addition
88+
to the x-axis property. Example: work items per assignee, broken down by priority within each
89+
assignee bar.
90+
91+
**Grouped** <Badge type="tip" text="Business" />
92+
93+
Each group produces a cluster of side-by-side bars, one per sub-group value. Unlike stacked,
94+
the bars are placed next to each other rather than on top. Best used when you need to compare
95+
sub-group values against each other across groups, rather than showing a total. Requires a
96+
group-by dimension. Example: issues per state, with separate bars per label shown side by
97+
side.
98+
99+
### Line chart
100+
101+
A line chart connects data points with a line across a continuous or ordered dimension.
102+
It is most useful when the x-axis is a date property (start date, due date, created at,
103+
completed at) with a date grouping applied, making trends over time legible. It can also be
104+
used with categorical dimensions when the ordering of categories matters.
105+
106+
**Basic**
107+
108+
A single line across all groups. You pick the line color, style (solid or dashed), whether
109+
to show data point markers, and whether to smooth the curve. Best for tracking a single
110+
metric over time. Example: number of work items completed per week over the last quarter.
111+
112+
**Multi-line** <Badge type="tip" text="Business" />
113+
114+
Multiple lines on the same chart, one per sub-group value. Each line has a distinct color
115+
from the selected color scheme. Best for comparing trends across multiple dimensions
116+
simultaneously. Requires a group-by dimension. Example: work items created per month, with
117+
separate lines per project.
118+
119+
### Area chart
120+
121+
An area chart is a line chart with the space beneath the line filled in. The fill
122+
communicates volume and cumulative weight more visually than a line alone. It is
123+
well-suited to showing how a quantity accumulates or changes over time.
124+
125+
**Basic**
126+
127+
A single filled area. You can configure the fill color, border line color and style, opacity,
128+
whether to show markers, and smoothing. Best for showing one metric over time with emphasis
129+
on magnitude. Example: total open work items per month.
130+
131+
**Stacked** <Badge type="tip" text="Business" />
132+
133+
Multiple filled areas stacked on top of each other, so the total height of the chart at any
134+
point represents the sum of all series. Each sub-group gets its own color. Best for showing
135+
how multiple categories contribute to an overall total over time. Requires a group-by
136+
dimension. Example: open work items over time, stacked by state group.
137+
138+
**Comparison** <Badge type="tip" text="Business" />
139+
140+
Two overlapping areas — one representing the primary metric and one a reference or comparison
141+
value — displayed with distinct colors and line styles (typically one solid and one dashed).
142+
Best for comparing actual versus expected, or current period versus prior period. Requires a
143+
group-by dimension. The comparison baseline is rendered with a dashed border by default.
144+
145+
### Donut chart
146+
147+
A donut chart is a ring divided into segments proportional to each group's value. The
148+
empty center distinguishes it from a pie chart and can optionally display a total count.
149+
It is most readable when you have a small number of distinct groups (5–8 at most) with
150+
meaningfully different proportions.
151+
152+
**Basic**
153+
154+
Segments sized by their proportion of the total. You choose a color scheme for the segments.
155+
Optionally display the total count in the center of the ring. Best for showing distribution
156+
across a small number of categories. Example: work item distribution by priority.
157+
158+
**Progress** <Badge type="tip" text="Business" />
52159

53-
#### Bar chart
160+
A two-segment ring showing completed versus total. One segment represents completed issues,
161+
the other represents remaining. You set the color for the completed segment; the remainder
162+
is neutral. The x-axis property is fixed to **state groups** for this model — it always
163+
measures completion by grouping issues into completed versus not-completed state groups.
164+
Best for a simple at-a-glance progress indicator. Example: percentage of work items completed
165+
in a given set of projects.
54166

55-
Perfect for comparing quantities across categories, like work items by priority or state. The bars make it easy to spot patterns and imbalances.
167+
### Pie chart
56168

57-
#### Line chart
169+
A pie chart is a circle divided into slices proportional to each group's value. It conveys
170+
the same information as a donut chart but without the center space. It is best when you have
171+
a small number of groups and care about the relative proportion more than the absolute count.
58172

59-
Ideal for tracking trends over time, such as completed work items per week. Use these to identify patterns and forecast future performance.
173+
**Basic**
60174

61-
#### Area chart
175+
Slices sized by proportion. You can display values on each slice as either a raw count or a
176+
percentage of the total. A thin-slice grouping option combines all slices below a configurable
177+
percentage threshold into a single "Other" segment, preventing many tiny slivers from making
178+
the chart unreadable.
62179

63-
Similar to line charts but with the area below the line filled in, making it easier to visualize volume changes over time.
180+
### Number
64181

65-
#### Donut chart
182+
A number widget displays a single large metric value with no chart — just the computed
183+
count or metric rendered as text. It is the fastest way to communicate one key figure and
184+
works well as a dashboard header or summary widget alongside more detailed charts.
66185

67-
Great for showing proportions and percentages of a whole, like work item types or assignee workload distribution.
186+
**Basic**
68187

69-
#### Pie chart
188+
You configure the text alignment (left, center, or right) and text color. The widget
189+
displays the y-axis metric for the full issue set matching the dashboard and widget filters.
190+
There is no x-axis property or grouping for number widgets — they compute a single aggregate.
70191

71-
Another option for displaying proportional data when you need to see how different segments relate to the whole.
192+
Note: the number widget supports all y-axis metrics except estimate points. If you need an
193+
estimate point total as a single number, use a table chart instead.
72194

73-
#### Number
195+
### Table chart
74196

75-
Simple counters that show important metrics like total work items, overdue tasks, or completed items. Use these for at-a-glance KPIs.
197+
A table chart renders issues grouped by the x-axis property as rows, with a count column.
198+
It presents the same data as a bar chart but in a structured grid format rather than a
199+
visual chart. It is useful when the precise numbers matter more than the visual shape of
200+
the distribution, or when you need to display many groups that would be hard to read as bars.
76201

77-
### Customize Widgets
202+
**Basic**
203+
204+
One row per group, with a count column. The y-axis metric is fixed to **work item count**
205+
and cannot be changed — table charts always show a raw count. The appearance settings
206+
(column color, legend, tooltip) match the bar chart config options.
207+
208+
## Configure a widget
209+
210+
Open the configuration sidebar by clicking the widget or by clicking the pencil icon.
78211

79212
![Customize Widget](https://media.docs.plane.so/dashboards/customize-widget.webp#hero)
80213

81-
Each widget type comes with specific configuration options:
214+
**Basic config**
215+
216+
- **Name** - the widget's title as displayed on the dashboard.
217+
218+
**X-axis property**
219+
What to group work items by along the horizontal axis (or segments for pie/donut).
220+
221+
_Options:_
222+
223+
- State, State group
224+
- Priority
225+
- Assignees, Created by
226+
- Labels
227+
- Cycles, Modules
228+
- Epics
229+
- Work item types
230+
- Projects
231+
- Start date, Due date, Created date, Completed date
232+
233+
When a date property is selected for the x-axis, you also choose a **date grouping**: Day, Week, Month, or Year. Plane truncates dates to the chosen granularity and groups work items accordingly.
234+
235+
**Y-axis metric**
236+
What value to compute per group.
82237

83-
#### Data selection
238+
| Metric | What it counts |
239+
| ---------------------- | ---------------------------------------------- |
240+
| Work item count | Total issues in each group |
241+
| Estimate points | Sum of story points in each group |
242+
| Pending work items | Issues in backlog, unstarted, or started state |
243+
| Completed work items | Issues in completed state |
244+
| In-progress work items | Issues in unstarted or started state |
245+
| Due today | Issues with a due date of today |
246+
| Due this week | Issues with a due date in the current week |
247+
| Blocked work items | Issues that have a blocked-by relationship |
84248

85-
- **Property**
86-
Choose what data to group by (e.g., Work item Types, Priority, Assignee)
87-
- **Metric**
88-
Select what to measure (e.g., Work item count, Estimate points)
249+
Estimate points require the project to have estimates configured in points mode. If a project does not have estimate points set up, that metric returns zero for work items in that project.
89250

90-
#### Appearance
251+
**Group by**
252+
Adds a second dimension by splitting each x-axis bar or line into sub-series. Available for Stacked, Grouped, Multi-line, and Comparison models. Uses the same options as the x-axis property.
91253

92-
- **Color scheme**
93-
Choose from preset palettes like `Modern`, `Horizon`, or `Earthen`.
254+
**Style config**
255+
Appearance options vary by chart type
94256

95-
- **Center value**
96-
Toggle whether to show the total count in the middle of donut/pie charts.
257+
- Bar chart: color, orientation (vertical/horizontal), legends, tooltip, color scheme
258+
- Line chart: line color, line type (solid/dashed), markers, smoothing, legends, tooltip, color scheme
259+
- Area chart: fill color, line color, line type, opacity, border, markers, smoothing, legends, tooltip, color scheme
260+
- Pie chart: group thin slices toggle, minimum threshold, value type (percentage or count), color scheme
261+
- Donut chart: center value toggle, completed color, color scheme
262+
- Number: text alignment (left/center/right), text color
263+
- Table: same options as bar chart
97264

98-
- **Legends and Tooltips**
99-
Enable or disable these to control how much detail appears
265+
**Filters**
266+
Widget-level filters narrow the issue data for this widget only, on top of any dashboard-level filters.
100267

101-
#### Style options
268+
## Filter layering
102269

103-
- **Fill color and Opacity**
104-
Customize the look of area charts
270+
Dashboards have two levels of filters that apply to all widget data in a stacked order:
105271

106-
- **Borders and Smoothing**
107-
Refine the appearance of your charts
272+
**Dashboard-level filters** are set once on the dashboard and apply to every widget on it.
273+
They restrict the base work item pool from which all widgets compute their data.
108274

109-
- **Markers**
110-
Add data point indicators on line charts
275+
**Widget-level filters** apply on top of the dashboard-level filters and further restrict data
276+
for that individual widget only.
277+
278+
When a widget fetches data, Plane applies filters in this order:
279+
280+
1. Dashboard-level filters
281+
2. Dashboard-level PQL filters
282+
3. Widget-level filters
283+
284+
The result is always the intersection — widget-level filters can only narrow, never expand, the work item set defined by dashboard filters.
285+
286+
Triage states and archived and draft work items are always excluded from widget data regardless of filters.
111287

112288
## Interact with your dashboard
113289

@@ -117,4 +293,61 @@ After setting up your widgets, use your dashboard for insights:
117293

118294
- Hover over chart elements to see detailed tooltips.
119295
- Use the legends to identify specific categories.
120-
- Click the **View** or **Edit** button at the top right corner to switch from edit to view mode.
296+
297+
## Export a dashboard
298+
299+
A dashboard can be exported to a PDF file. Each widget is rendered into its export block type:
300+
301+
- Chart widgets (bar, line, area, pie, donut) are captured as PNG images
302+
- Table widgets are exported as structured tables
303+
- Number widgets are exported with their value, text color, and alignment preserved
304+
305+
1. Open the dashboard.
306+
2. Click the **Export** button in the toolbar or **...** menu → **Export**.
307+
3. Choose orientation (portrait or landscape).
308+
4. Click **Download**.
309+
310+
Plane renders each widget into the PDF. Chart widgets become images; table and number widgets
311+
are rendered as structured content. The PDF renderer respects the desktop grid layout and places widgets in their configured
312+
positions and sizes across pages.
313+
314+
## Resize a widget
315+
316+
1. Hover over the widget until the resize handle appears at the bottom-right corner.
317+
2. Drag the handle to change the widget's size.
318+
3. Release to save the new size. Layout is auto-saved.
319+
320+
## Reposition a widget
321+
322+
1. Click and hold the widget's header area.
323+
2. Drag it to the new position on the grid.
324+
3. Release to drop. Other widgets shift to fill the space. Layout is auto-saved.
325+
326+
## Delete a widget
327+
328+
1. Hover over the widget.
329+
2. Click the **...** menu → **Delete**.
330+
3. Confirm. The widget is permanently removed.
331+
332+
## Add a dashboard to favorites
333+
334+
1. In the dashboards list, hover over the dashboard.
335+
2. Click the **star** icon.
336+
337+
Or from inside the dashboard:
338+
339+
- Click the **star** icon in the dashboard header.
340+
341+
## Delete a dashboard
342+
343+
1. Go to the dashboards list.
344+
2. Click the **...** menu on the dashboard → **Delete**.
345+
3. Confirm.
346+
347+
Only the dashboard owner can delete a dashboard.
348+
349+
---
350+
351+
You can build up to any number of dashboards per workspace. Each dashboard draws from one or more projects you choose and holds any number of widgets. There is no enforced limit on widgets per dashboard, though very large grids become difficult to navigate in practice.
352+
353+
You can visualize work across **7 chart types**, each with up to **6 chart models**, giving 42 chart type/model combinations. Each widget is independently configured with its own grouping dimension, metric, date grouping (where applicable), appearance settings, and filter expression.

0 commit comments

Comments
 (0)