Skip to content

Commit 79aeb09

Browse files
authored
Merge pull request #261 from nocodb/docs/chart
Docs/chart
2 parents 9688ee2 + 9266def commit 79aeb09

16 files changed

+142
-0
lines changed
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: 'Bar Chart'
3+
description: 'Configure bar chart widgets to compare values across categories in your dashboard'
4+
---
5+
6+
![Bar Chart](/img/v2/dashboards/widget-bar-chart-home.png)
7+
8+
The **Bar Chart** widget in NocoDB dashboards allows you to compare values across different categories. It is especially useful for highlighting trends, distributions, or comparisons between groups.
9+
10+
## Title & Description
11+
- **Title**: Enter a title for the bar chart widget. This will be displayed prominently at the top of the widget.
12+
- **Description**: Optionally, add a description to provide context or details about the data being visualized. This will appear below the title.
13+
14+
<img
15+
src="/img/v2/dashboards/widget-bar-chart-title.png"
16+
alt="Title"
17+
style={{ width: "50%" }}
18+
/>
19+
20+
21+
## Data Source
22+
- **Table**: Select the table from which you want to pull data for the bar chart.
23+
- **Records**: Choose which records to include:
24+
- **All Records**: Displays all records from the selected table.
25+
- **Records from a view**: Uses records from a specific view, allowing you to apply existing filters and sorts.
26+
- **Specific Records**: Apply custom filters to select only certain records.
27+
28+
<img
29+
src="/img/v2/dashboards/widget-bar-chart-source.png"
30+
alt="Title"
31+
style={{ width: "50%" }}
32+
/>
33+
34+
## Display
35+
36+
### X-axis
37+
- **Field**: Select the field whose values will be shown as categories along the X-axis (e.g., Product, Region, Status).
38+
- **Sort By**: Choose the criteria to sort categories:
39+
- **xAxis Value**: Sorts based on the label values.
40+
- **yAxis Value**: Sorts based on the numeric values plotted.
41+
- **Order**: Select Default, Ascending, or Descending order.
42+
- **Include empty records**: Optionally, include categories that do not have values.
43+
- **Include others**: Toggle to combine small or excess categories into an “Others” group for better readability.
44+
45+
### Y-axis
46+
- **Fields**: Choose the field(s) that determine the bar lengths. You can add multiple fields for comparison.
47+
- **Field Summary**: Displays the **Sum, Average, Min, or Max** of a numeric field.
48+
- **Start at zero**: Ensures the Y-axis always begins at zero, which improves accuracy in comparing bar heights.
49+
50+
<img
51+
src="/img/v2/dashboards/widget-bar-chart-axis.png"
52+
alt="Title"
53+
style={{ width: "50%" }}
54+
/>
55+
56+
## Appearance
57+
58+
Customize the look of the chart to improve readability and alignment with your dashboard:
59+
60+
- **Size**: Choose the chart size (Small, Medium).
61+
- **Show value in chart**: Displays numeric values directly on the bars.
62+
- **Show count in legend**: Adds record counts in the legend alongside category names.
63+
64+
<img
65+
src="/img/v2/dashboards/widget-bar-chart-style.png"
66+
alt="Title"
67+
style={{ width: "50%" }}
68+
/>

content/docs/dashboards/widgets/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ NocoDB dashboards support the following widget types:
1010
| Widget Type | Description |
1111
|----------------------------------------------------------------------|----------------------------------------|
1212
| **[Number](/docs/product-docs/dashboards/widgets/number)** | Displays KPIs and metric summaries |
13+
| **[Bar Chart](/docs/product-docs/dashboards/widgets/bar-chart)** | Compares values across categories |
14+
| **[Line Chart](/docs/product-docs/dashboards/widgets/line-chart)** | Shows trends over time |
1315
| **[Pie Chart](/docs/product-docs/dashboards/widgets/pie-chart)** | Visualizes parts of a whole |
1416
| **[Donut Chart](/docs/product-docs/dashboards/widgets/donut-chart)** | Pie chart variant with a hollow center |
1517
| **[Text](/docs/product-docs/dashboards/widgets/text)** | Displays static information |
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: 'Line Chart'
3+
description: 'Configure line chart widgets to visualize trends and comparisons over time or categories in your dashboard'
4+
---
5+
6+
![Line Chart](/img/v2/dashboards/widget-line-graph-home.png)
7+
8+
The **Line Chart** widget in NocoDB dashboards allows you to visualize trends and comparisons across categories or time. It is especially useful for tracking changes, identifying patterns, and comparing multiple metrics simultaneously.
9+
10+
## Title & Description
11+
- **Title**: Enter a title for the line chart widget. This will be displayed prominently at the top of the widget.
12+
- **Description**: Optionally, add a description to provide context or details about the data being visualized. This will appear below the title.
13+
14+
<img
15+
src="/img/v2/dashboards/widget-line-graph-title.png"
16+
alt="Line Chart Title"
17+
style={{ width: "50%" }}
18+
/>
19+
20+
## Data Source
21+
- **Table**: Select the table from which you want to pull data for the line chart.
22+
- **Records**: Choose which records to include:
23+
- **All Records**: Displays all records from the selected table.
24+
- **Records from a view**: Uses records from a specific view, allowing you to apply filters and sorts.
25+
- **Specific Records**: Apply custom filters to select only certain records.
26+
27+
<img
28+
src="/img/v2/dashboards/widget-line-graph-source.png"
29+
alt="Line Chart Data Source"
30+
style={{ width: "50%" }}
31+
/>
32+
33+
## Display
34+
35+
### X-axis
36+
- **Field**: Select the field whose values will be shown along the X-axis (e.g., Date, Product, Category).
37+
- **Sort By**: Choose how categories are sorted:
38+
- **xAxis Value**: Sorts based on the label values.
39+
- **yAxis Value**: Sorts based on the numeric values plotted.
40+
- **Order**: Select Default, Ascending, or Descending.
41+
- **Include empty records**: Optionally include categories that have no values.
42+
- **Include others**: Toggle to group smaller categories into an “Others” bucket.
43+
44+
### Y-axis
45+
- **Fields**: Choose the field(s) to plot on the Y-axis. You can add multiple fields to display multiple lines in the chart.
46+
- **Record Count**: Shows the number of records for each category.
47+
- **Field Summary**: Displays the **Sum, Average, Min, or Max** of a numeric field.
48+
- **Start at zero**: Ensures the Y-axis always begins at zero for consistency.
49+
50+
<img
51+
src="/img/v2/dashboards/widget-line-graph-axis.png"
52+
alt="Line Chart Axis Config"
53+
style={{ width: "50%" }}
54+
/>
55+
56+
## Appearance
57+
58+
Customize how the chart is displayed for clarity and readability:
59+
60+
- **Size**: Adjust the chart size (Small, Medium).
61+
- **Legend Orientation**: Choose where to display the legend (Top, Bottom, Left, Right).
62+
- **Show count in legend**: Enable to display record counts in the legend.
63+
- **Plot data points**: Enable to highlight data points on the line.
64+
- **Smooth lines**: Enable to display smoothed curves instead of jagged lines.
65+
66+
<img
67+
src="/img/v2/dashboards/widget-line-graph-style.png"
68+
alt="Line Chart Appearance"
69+
style={{ width: "50%" }}
70+
/>

content/docs/dashboards/widgets/meta.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
"pages": [
33
"number",
44
"text",
5+
"bar-chart",
6+
"line-chart",
57
"pie-chart",
68
"donut-chart",
79
"iframe"
108 KB
Loading
87.7 KB
Loading
88.3 KB
Loading
60.8 KB
Loading
88 KB
Loading
103 KB
Loading

0 commit comments

Comments
 (0)