You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dashboards.md
+61-30Lines changed: 61 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,13 @@ description: Build custom dashboards in Plane to visualize project metrics.
5
5
6
6
# Dashboards <Badgetype="info"text="Pro" />
7
7
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.
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.
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
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.
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.
@@ -27,14 +27,25 @@ Dashboards are workspace-scoped. They are not tied to a single project — each
27
27
</div>
28
28
-->
29
29
30
+
## Dashboards visibility
31
+
32
+
Every dashboard has a visibility setting.
33
+
34
+
### Public dashboards
35
+
36
+
Public dashboards are visible to everyone in your workspace. Any workspace member can open a public dashboard and see the data it displays. Only the creator, workspace admins, and owners can edit or delete a public dashboard.
Private dashboards are visible only to you. Other workspace members can't see private dashboards in their list. A private dashboard is the right choice for metrics you're building out, drafts, or data you don't want to share workspace-wide.
41
+
42
+
When you create a dashboard, the default visibility is **Public**. You can change a dashboard's visibility after creation from within the dashboard.
43
+
30
44
## Widgets
31
45
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.
46
+
A widget is a single chart or metric panel on a dashboard. You configure each widget independently with its own chart type, data axes, grouping, and filters. Widgets sit on a shared grid and can be resized and repositioned freely.
35
47
36
-
Every widget answers a question of the form: _"For these work items, grouped by X, what is the
37
-
count/metric of Y?"_
48
+
Every widget answers a question of the form: _"For these work items, grouped by X, what is the count/metric of Y?"_
38
49
39
50
## Create a dashboard
40
51
@@ -46,7 +57,20 @@ count/metric of Y?"_
46
57
4. Under **Projects**, select one or more projects whose issues this dashboard should draw
47
58
data from. All widgets on this dashboard can only see issues from these projects.
48
59
5. Optionally set **filters** to restrict the base work item pool for all widgets.
49
-
6. Click **Create dashboard** to finish.
60
+
6. If Private Dashboards is enabled on your plan, set the **Visibility** to Public or Private.
61
+
7. Click **Create dashboard** to finish.
62
+
63
+
## Switch between edit mode and view mode
64
+
65
+
When you open a dashboard, you're in view mode by default. In view mode, you can see widget data but can't add, configure, move, or resize widgets.
66
+
67
+
To make changes to a dashboard, switch to edit mode:
68
+
69
+
1. Click **Edit** in the header.
70
+
2. Make your changes.
71
+
3. Click **View** to return to view mode.
72
+
73
+
The **Edit** button is only visible if you have edit permission on the dashboard.
50
74
51
75
## Add widgets to a dashboard
52
76
@@ -58,20 +82,20 @@ Once you've created a dashboard, it's time to add widgets. Widgets are visualiza
58
82
2. Click **Add widget** in the toolbar.
59
83
3. In the widget type selector, choose a chart type and model.
60
84
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,
85
+
5. The configuration sidebar opens automatically - configure the widget's axes, metrics,
62
86
and filters (see below).
63
87
6. Click **Save** or close the sidebar.
64
88
65
89
## Widget types and models
66
90
67
-
Each widget type supports one or more **models**— variations that change how the data series
91
+
Each widget type supports one or more **models**- variations that change how the data series
68
92
is structured and displayed.
69
93
70
94
### Bar chart
71
95
72
96
A bar chart plots one value per group as a rectangular bar. Bars can run vertically
73
97
(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,
98
+
versatile chart type for comparing values across discrete categories - states, assignees,
75
99
priorities, labels, and so on.
76
100
77
101
**Basic**
@@ -137,8 +161,8 @@ dimension. Example: open work items over time, stacked by state group.
137
161
138
162
**Comparison** <Badgetype="tip"text="Business" />
139
163
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).
164
+
Two overlapping areas - one representing the primary metric and one a reference or comparison
165
+
value - displayed with distinct colors and line styles (typically one solid and one dashed).
142
166
Best for comparing actual versus expected, or current period versus prior period. Requires a
143
167
group-by dimension. The comparison baseline is rendered with a dashed border by default.
144
168
@@ -159,7 +183,7 @@ across a small number of categories. Example: work item distribution by priority
159
183
160
184
A two-segment ring showing completed versus total. One segment represents completed issues,
161
185
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
186
+
is neutral. The x-axis property is fixed to **state groups** for this model - it always
163
187
measures completion by grouping issues into completed versus not-completed state groups.
164
188
Best for a simple at-a-glance progress indicator. Example: percentage of work items completed
165
189
in a given set of projects.
@@ -179,15 +203,15 @@ the chart unreadable.
179
203
180
204
### Number
181
205
182
-
A number widget displays a single large metric value with no chart — just the computed
206
+
A number widget displays a single large metric value with no chart - just the computed
183
207
count or metric rendered as text. It is the fastest way to communicate one key figure and
184
208
works well as a dashboard header or summary widget alongside more detailed charts.
185
209
186
210
**Basic**
187
211
188
212
You configure the text alignment (left, center, or right) and text color. The widget
189
213
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.
214
+
There is no x-axis property or grouping for number widgets - they compute a single aggregate.
191
215
192
216
Note: the number widget supports all y-axis metrics except estimate points. If you need an
193
217
estimate point total as a single number, use a table chart instead.
@@ -202,7 +226,7 @@ the distribution, or when you need to display many groups that would be hard to
202
226
**Basic**
203
227
204
228
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
229
+
and cannot be changed - table charts always show a raw count. The appearance settings
206
230
(column color, legend, tooltip) match the bar chart config options.
207
231
208
232
## Configure a widget
@@ -281,10 +305,19 @@ When a widget fetches data, Plane applies filters in this order:
281
305
2. Dashboard-level PQL filters
282
306
3. Widget-level filters
283
307
284
-
The result is always the intersection — widget-level filters can only narrow, never expand, the work item set defined by dashboard filters.
308
+
The result is always the intersection - widget-level filters can only narrow, never expand, the work item set defined by dashboard filters.
285
309
286
310
Triage states and archived and draft work items are always excluded from widget data regardless of filters.
287
311
312
+
## Change a dashboard's visibility <Badgetype="tip"text="Business" />
313
+
314
+
1. Open the dashboard.
315
+
2. In the header, click the button that shows the current access level - it displays either **Public** or **Private**.
316
+
3. In the modal that opens, select the new access level.
317
+
4. Click **Confirm**.
318
+
319
+
Only the dashboard creator, workspace admins, and owners can change visibility.
320
+
288
321
## Interact with your dashboard
289
322
290
323

@@ -311,17 +344,14 @@ Plane renders each widget into the PDF. Chart widgets become images; table and n
311
344
are rendered as structured content. The PDF renderer respects the desktop grid layout and places widgets in their configured
312
345
positions and sizes across pages.
313
346
314
-
## Resize a widget
347
+
## Resize and reposition widgets
315
348
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.
349
+
While a dashboard is in **edit mode**:
319
350
320
-
## Reposition a widget
351
+
-**Resize** — drag the resize handle at the bottom-right corner of a widget to change its height or width.
352
+
-**Reposition** — drag the widget by its header to move it to a different position on the grid.
321
353
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.
354
+
Positions and sizes are saved when you make a change.
325
355
326
356
## Delete a widget
327
357
@@ -331,12 +361,13 @@ positions and sizes across pages.
331
361
332
362
## Add a dashboard to favorites
333
363
334
-
1. In the dashboards list, hover over the dashboard.
335
-
2. Click the **star** icon.
364
+
On the dashboard list, click the star icon on a dashboard to mark it as a favorite. Click again to remove it.
336
365
337
-
Or from inside the dashboard:
366
+
You can also favorite from inside the dashboard.
338
367
339
-
- Click the **star** icon in the dashboard header.
368
+
:::info
369
+
Only the dashboard creator, workspace admins, and owners can favorite a dashboard.
Copy file name to clipboardExpand all lines: docs/pages/collections.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ In your wiki sidebar, collections appear as a flat list. When you expand a colle
13
13
14
14
Every workspace starts with one collection called **General**. Plane creates it automatically, and it works as the default landing spot for any new wiki page you create without explicitly placing it somewhere else. You can add pages to it and move pages out of it, but you can't rename it or delete it.
15
15
16
-
## Public collections vs. Private collections
16
+
## Collections visibility
17
17
18
18
Plane gives you two kinds of collections, and the difference comes down to who can see what's inside.
0 commit comments