diff --git a/docs/questions/images/progress-bar-elements.png b/docs/questions/images/progress-bar-elements.png new file mode 100644 index 0000000000000000000000000000000000000000..80ffc13a49a7b75649c3861c9984a3b42569ade2 Binary files /dev/null and b/docs/questions/images/progress-bar-elements.png differ diff --git a/docs/questions/images/progress-with-format.png b/docs/questions/images/progress-with-format.png new file mode 100644 index 0000000000000000000000000000000000000000..55497ce3312caaf962cd55df6fe7f83ed798a737 Binary files /dev/null and b/docs/questions/images/progress-with-format.png differ diff --git a/docs/questions/images/progress.png b/docs/questions/images/progress.png index 5e85633879c223716c75e180282058469887a80d..e161f5fdabb9ad0b776641fb5a46f0464ab43da0 100644 Binary files a/docs/questions/images/progress.png and b/docs/questions/images/progress.png differ diff --git a/docs/questions/sharing/visualizations/progress-bar.md b/docs/questions/sharing/visualizations/progress-bar.md index d45f7d1526f2b48de8330f171c6f9bc2096c5d7a..e222bc4cbc4976f6d942893a256745a9beef9f90 100644 --- a/docs/questions/sharing/visualizations/progress-bar.md +++ b/docs/questions/sharing/visualizations/progress-bar.md @@ -4,6 +4,46 @@ title: Progress bars # Progress bars -**Progress bars** are for comparing a single number to a goal value that you set. Open up the settings for your progress bar to choose a value for your goal, and Metabase will show you how far away your question's current result is from the goal. +**Progress bars** are for comparing a single number to a goal value that you set.  + +## When to use a progress bar + +Progress bars are useful when you want to show the movement of a metric toward a goal, like assessing performance of a KPI, or tracking the percentage of of completion on a project. + +Progress bars give you an option to set up an alert whenever the result of a question reaches the goal set in the progress bar settings. See [Progress bar alerts](../alerts.md#progress-bar-alerts). + +## How to create a progress bar + +To create a progress bar you'll need: + +- A query that returns a single number, like "Sum of order quantity". Progress bar doesn't work with breakouts. + +- A goal value. The goal value should be a positive number. Currently, Metabase only supports setting a static goal (you can't set a goal based on another query). + + The goal is set in the [chart options](#progress-bar-options). + + + +## Progress bar options + +To open the chart options, click on the gear icon at the bottom left of the screen. + +Format options will apply to both the result of the query and the goal value: + + + +Selecting "**Style**: Percent" in format options will only change how the result of the query is formatted: for example, `17` will be formatted as `1700%`. If you instead want to display the query result as a percentage of the goal, you'll need to calculate that percentage in your query. For example, to display the count of orders as a percentage of the goal of `20`, use [custom expressions](../../query-builder/expressions.md) to return "Count of orders divided by 20", and format the result as a percentage. + +## Limitations and alternatives + +- Progress bars assume that your objective is to _increase_ a metric. If the objective is to decrease or reduce a metric, consider using the [gauge chart](gauge.md). + +- Progress bars don't support breakouts. If you'd like to display progress of a metric towards a goal across a breakout, consider using a [bar or line chart with a goal line](line-bar-and-area-charts.md#goal-lines). + +## See also + +- [Gauge charts](./gauge.md) +- [Goal lines on bar and line charts](./line-bar-and-area-charts.md#goal-lines) +- Tutorial: [Which chart should I use?](https://www.metabase.com/learn/metabase-basics/querying-and-dashboards/visualization/chart-guide)