Skip to content

Commit c75a93b

Browse files
Split chart types into individual pages (#293)
* Update references/chart-types/overview.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/bar-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/horizontal-bar-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/line-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/area-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/mixed-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/scatter-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/pie-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/funnel-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/treemap-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/gauge.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/table.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/map.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/big-value.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/configure-charts.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update docs.json Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Delete references/chart-types.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update docs.json Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/bar-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/horizontal-bar-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/line-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/mixed-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/pie-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/funnel-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/treemap-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/table.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/big-value.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/map.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/custom-charts.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/area-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/gauge.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update references/chart-types/scatter-chart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> * Update docs.json Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Jake Peterson <5532776+jpetey75@users.noreply.github.com>
1 parent acb456c commit c75a93b

18 files changed

+661
-614
lines changed

docs.json

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,34 @@
5050
"icon": "person-chalkboard",
5151
"pages": [
5252
"guides/metrics-catalog",
53-
"references/chart-types",
53+
{
54+
"group": "Chart types",
55+
"pages": [
56+
"references/chart-types/overview",
57+
"references/chart-types/bar-chart",
58+
"references/chart-types/horizontal-bar-chart",
59+
"references/chart-types/line-chart",
60+
"references/chart-types/area-chart",
61+
"references/chart-types/mixed-chart",
62+
"references/chart-types/scatter-chart",
63+
"references/chart-types/pie-chart",
64+
"references/chart-types/funnel-chart",
65+
"references/chart-types/treemap-chart",
66+
"references/chart-types/table",
67+
"references/chart-types/big-value",
68+
"references/chart-types/gauge",
69+
"references/chart-types/map",
70+
"references/custom-charts"
71+
]
72+
},
73+
"references/chart-types/configure-charts",
5474
"guides/how-to-create-scheduled-deliveries",
5575
"guides/how-to-create-alerts",
5676
"guides/using-slack-integration",
5777
"guides/limiting-data-using-filters",
5878
"references/filters",
5979
"guides/formatting-your-fields",
6080
"guides/period-over-period",
61-
"references/custom-charts",
6281
"references/custom-fields",
6382
"references/custom-tooltip",
6483
"guides/version-history",

references/chart-types.mdx

Lines changed: 0 additions & 612 deletions
This file was deleted.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Area chart"
3+
description: "Use area charts to show how values develop over time when the total is as important as its parts."
4+
icon: "chart-area"
5+
---
6+
7+
<Frame>
8+
![](/images/references/stacked-area-chart-a45960a0c1a7e535aebd5c55671d68f1.png)
9+
</Frame>
10+
11+
Area charts are best if:
12+
13+
- **you want to show how values develop over time.** If you want to show how values differ in different categories, consider a (stacked) bar, or horizontal bar chart instead.
14+
- **the total is as important as its parts**. If the total (= the height of all your stacked areas) is not important, consider a line chart instead. Many readers will have an easier time understanding a line chart than an area chart.
15+
- **there are big differences between your values**. If the differences between your values are very small, consider a line chart instead. Compared to an area chart, the y-axis of a line chart doesn't need to start at zero. This means that your y-axis can be stretched to show the tiny differences.
16+
- **you're showing multiple series over time**. If you just want to show one value over time, also consider a line chart instead; especially if you don't want your y-axis to start at zero. If you only have a few dates, you can also consider using a column chart. In both cases, labelling will be better.
17+
- **you have many data points**. If you have less than ten or so data points, consider a stacked bar chart instead.
18+
19+
You can see more details about area chart configurations [here](/references/chart-types/configure-charts).
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: "Bar chart"
3+
description: "Use bar charts to compare things between different groups or track how a number changes over time."
4+
icon: "chart-column"
5+
---
6+
7+
<Frame>
8+
![](/images/references/bar-chart-35c37cf2474d6c73ffe23f6149b3242a.png)
9+
</Frame>
10+
11+
Bar charts are helpful to:
12+
13+
- compare things between different groups (e.g. the number of orders you have by product type)
14+
- track how a number changes over time if you have a _smaller number of x-axis values_ (e.g. number of new users per month over a year).
15+
16+
Check out more details about bar chart configurations [here](/references/chart-types/configure-charts).
17+
18+
## Stacked bar chart
19+
20+
<Frame>
21+
![](/images/references/stacked-bar-chart-d726cb2cc98f232364fdc64a26e1f290.png)
22+
</Frame>
23+
24+
You can also stack bar charts to compare proportions across different groups.
25+
26+
Stacked bar charts work best when:
27+
28+
- **_the focus of the chart is to compare the totals and one part of the totals._** It's hard to compare bars if they don't start at the same baseline. So, if you're trying to build a chart to compare multiple parts of your total with each other, consider keeping your bar chart unstacked!
29+
- **_you're trying to show the parts of multiple totals_**. If you only want to show parts of one total, consider an unstacked bar chart instead. If you only want to communicate one part of one total, consider if you should be using a big value chart instead.
30+
31+
## 100% Stacked bar chart
32+
33+
<Frame>
34+
![](/images/references/hundred-stacked-bar-chart-2d1859c3f28d559e4a435fa8f96188cb.png)
35+
</Frame>
36+
37+
You can easily create 100% stacked bar charts easily by just selecting the `100%` stacking option on the chart configuration. After enabling this option, we will automatically transform the data and the axes to display a 100% stacked bar chart.
38+
39+
![download.png](/images/download.png)
40+
41+
<Expandable title="how to also create 100% bar chart using table calculations">
42+
43+
44+
You can also create a 100% stacked bar chart by setting up a [table calculation for percent of group total](/guides/table-calculations/table-calculation-sql-templates/percent-of-group-pivot-total). Use your x-axis dimension as the `column_i_want_to_group_by`, then in your chart configuration choose your x-axis, group dimension, and the new table calculation as your y-axis.
45+
</Expandable>
46+
47+
100% Stacked Bar Charts are useful when you need to visualize how the composition of a metric changes over time, or how the composition changes across different groups.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Big value"
3+
description: "Use big value charts to display a single value prominently."
4+
icon: "hundred-points"
5+
---
6+
7+
<Frame>
8+
![](/images/references/big-value-chart.png)
9+
</Frame>
10+
11+
The Big value option is for displaying a single value, well, big.
12+
13+
The Big value works for any type of value: string, numeric, boolean, you name it! We always display the first value from the field in your results table.
14+
15+
The options for Big value include:
16+
17+
- Selecting which field you want to use for your Big value.
18+
- Updating the label below the Big value value.
19+
- Adding a comparison to the previous row
20+
- Show raw value or percentage change
21+
- Show red or green for positive or negative change
22+
- Label your comparison value
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
title: "Configure your charts"
3+
description: "Learn about the configuration options available for most chart types in Lightdash."
4+
---
5+
6+
Most chart types have very similar configuration options, so we put them all together below.
7+
8+
## Layout
9+
10+
This is where you can pick the columns from your results table that you want to plot on your x and y axes or that you want to group by.
11+
12+
You can group by up to 3 fields in your chart.
13+
14+
For bar charts, this is also where you have the option to stack your bars, or leave them unstacked (grouped).
15+
16+
<Frame>
17+
![](/images/references/chart-config-layout.png)
18+
</Frame>
19+
20+
## Series
21+
22+
The series tab is where you can adjust how your chart shows each data series. A **data series** is a set of related data points plotted on a chart. For example, the number of new users created each day over a set of dates is a series. In a bar chart, a series is represented by bars of the same color; in a line chart, a series is represented by a single line. You can see a list of the series for your chart in the **Series** menu, and on the chart legend.
23+
24+
<Frame>
25+
![](/images/references/chart-config-series.png)
26+
</Frame>
27+
28+
The options available in here will depend on the data in your chart. But, in here you can:
29+
30+
- Set the chart type for each series
31+
- Change series labels or colors
32+
- Put series on a left or right y-axis
33+
- Show value labels or group totals on data points
34+
- Hide a series from your chart
35+
36+
## Axes
37+
38+
In this section you have options to:
39+
40+
- Override the default text for your axes labels
41+
- Adjust sort order of your x-axis
42+
- Rotate x-axis labels
43+
- Set the min and max axis values for your y-axes (or keep the default auto y-axis range)
44+
- Show x-axis and y-axis grid lines
45+
- Hide x-axis completely
46+
- Hide y-axis completely
47+
48+
<Frame>
49+
![](/images/references/chart-config-axes.png)
50+
</Frame>
51+
52+
## Display
53+
54+
This tab is where you're able to control the legend, reference lines, and [custom tooltips](/references/custom-tooltip) in your chart.
55+
56+
### Reference lines
57+
58+
You can add reference lines to your charts to easily visualize goals or thresholds.
59+
60+
<Frame>
61+
![](/images/references/add-reference-line-40558dfcc4473f5b981875936ddba85f.png)
62+
</Frame>
63+
64+
To add a reference line, click `+ Add` under Display -> Reference lines.
65+
66+
You have these options in the settings:
67+
68+
- Select a field you want to linke to your reference line (Page views in the image above)
69+
- Set a static value (50,000 in the image above)
70+
- Add a label (`Halfway to our goal!` in the image above)
71+
- Change the line color (green in the image above)
72+
73+
<Tip>
74+
Most reference lines are static values, but you can also use these key words to plot a dynamic value: `min`, `max`, `median`, `average`.
75+
76+
That way your reference line will automatically update to the global min, max, median, or average of the field you selected. See image below for examples.
77+
</Tip>
78+
79+
![dynamic reference lines example](/images/references/chart-config-dynamic-reference.png)
80+
81+
If you select a field plotted on your x-axis, then your line will be vertical. If you select a field plotted on your y-axis, then your line will be horizontal.
82+
83+
<Tip>
84+
If your reference line label is cropped off your chart, try adjusting your [right margin](#margins).
85+
</Tip>
86+
87+
### Legend
88+
89+
You can add and adjust the legend in your chart to help people understand what data's been plotted.
90+
91+
- Show or hide the legend
92+
- Adjust the position of the legend on your chart
93+
- The values in `position` are the coordinates of the legend on your chart. They can either be numbers or percent. We suggest using %.
94+
- If you want the position to be in the bottom right, you would set: Right = 0%, Bottom = 0%. For the legend to be in the middle of the chart, you'd set: Top = 50%, Left = 50%.
95+
- Set your legend to scroll (if you have so many groups that they overlap your chart)
96+
- Orient the values in your legened to form a list vertically, or horizontally
97+
98+
<Frame>
99+
![](/images/references/chart-config-legend.png)
100+
</Frame>
101+
102+
## Margins
103+
104+
The Margin tab is where you're able to add or remove margin around the grid. Removing margin means that your chart will fill more of the space in the chart tab. Adding margin will shrink your chart into a smaller space.
105+
106+
You can either add numbers (e.g. 50) or percent values (e.g. 50%) to the margin settings listed. The default margin is set to `top` = 70, `bottom` = 30, `left` = 5%, `right` = 5%
107+
108+
<Frame>
109+
![](/images/references/chart-config-margins.png)
110+
</Frame>
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "Funnel chart"
3+
description: "Use funnel charts to show pipeline performance, product conversion metrics, or any process with discrete stages."
4+
icon: "arrow-down-wide-short"
5+
---
6+
7+
<Frame>
8+
![](/images/references/funnel-chart-4b04cd90e9b0670e30a9e2f62b458f03.png)
9+
</Frame>
10+
11+
Funnel charts work well for showing pipeline performance, product conversion metrics, onboarding flows, or any other process where things move from one discrete stage to another.
12+
13+
To use a funnel chart, you should have discrete stages of a process and numeric counts of entities in each stage.
14+
15+
The funnel will show the count at each stage and the percentage that number represents of the starting count, making it easy to visualize the proportion moving from one stage to the next.
16+
17+
## General settings
18+
19+
<Frame>
20+
![](/images/references/funnel-chart-general-3c4cde5b62337e8b2b3d70c5f47b874a.png)
21+
</Frame>
22+
23+
With the Lightdash funnel chart, you can use either a row or a column to describe the stages in your funnel.
24+
25+
Use the `Data orientation` switch to specify which orientation you would like to use.
26+
27+
When `rows` is selected, each row of your data represent one step. The first column in the data will be treated as the labels for the steps, and you can choose which **numeric** column to treat as the value of the step.
28+
29+
When `columns` is selected, you should have a numeric column for each step you want to display. Only the first row of data will be represented and the column names will be used as the step labels. Non-numeric columns will be ignored.

references/chart-types/gauge.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Gauge"
3+
description: "Use gauges to highlight a single value against a qualitative range, like performance against a target."
4+
icon: "gauge-high"
5+
---
6+
7+
<Frame>
8+
![](/images/references/gauge-chart.png)
9+
</Frame>
10+
11+
Gauges are useful when you want to highlight a single value against a qualitative range, like performance against a target. They work well for KPIs and operational dashboards where you need an at-a-glance status.
12+
13+
To create a gauge chart:
14+
15+
- Choose a single metric as the value to display.
16+
- Optionally define min and max bounds for the scale.
17+
- Configure colored ranges to communicate thresholds (for example: red, amber, green bands).
18+
19+
Tips:
20+
21+
- Use gauges sparingly and for monitoring, not detailed analysis.
22+
- Prefer descriptive labels and units so the value is immediately clear to viewers.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "Horizontal bar chart"
3+
description: "Use horizontal bar charts when grouping by values with long labels or many possible values."
4+
icon: "chart-simple-horizontal"
5+
---
6+
7+
<Frame>
8+
![](/images/references/horizontal-bar-chart-33d2cd0854a3a75e1b3b17cebe0493d5.png)
9+
</Frame>
10+
11+
Horizontal bar charts are just bar charts, except the columns are placed on the chart horizontally instead of vertically.
12+
13+
Horizontal bar charts are useful when:
14+
15+
- you're trying to group a number by something with a lot of possible values.
16+
- your groups have really long label names.
17+
18+
You can see more details about horizontal bar chart configurations [here](/references/chart-types/configure-charts).
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Line chart"
3+
description: "Use line charts to show changes in a number over a short or long period of time."
4+
icon: "chart-line"
5+
---
6+
7+
<Frame>
8+
![](/images/references/line-chart-27ae1d8580fc5304a59d188288abb0b0.png)
9+
</Frame>
10+
11+
Line charts are used to show changes in a number over a short or long period of time.
12+
13+
They're a good option when:
14+
15+
- **you have small changes between your values**. The y-axis of a line chart doesn't need to start at zero. This means that your y-axis can be stretched to show the tiny differences.
16+
- **you have lots of x-axis values**. In this case, line charts are better to use than bar charts.
17+
18+
Line charts with multiple lines can also be used to compare changes over the same period of time for more than one group.
19+
20+
<Frame>
21+
![](/images/references/multi-line-chart-2e61895408bac7da14ec71528ab8487f.png)
22+
</Frame>
23+
24+
You can see more details about line chart configurations [here](/references/chart-types/configure-charts).

0 commit comments

Comments
 (0)