Skip to content
Snippets Groups Projects
Unverified Commit 978cc097 authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

docs - dashboards (#24468)

parent 450f4b19
No related branches found
No related tags found
No related merge requests found
Showing
with 35 additions and 30 deletions
......@@ -55,11 +55,11 @@ title: Metabase documentation
## Dashboards
- [Creating dashboards](./users-guide/07-dashboards.md)
- [Dashboard filters](./users-guide/08-dashboard-filters.md)
- [Interactive dashboards](./users-guide/interactive-dashboards.md)
- [Dashboard charts with multiple series](./users-guide/09-multi-series-charting.md)
- [Setting up dashboard subscriptions](./users-guide/dashboard-subscriptions.md)
- [Creating dashboards](./dashboards/introduction.md)
- [Dashboard filters](./dashboards/filters.md)
- [Interactive dashboards](./dashboards/interactive.md)
- [Dashboard charts with multiple series](./dashboards/multiple-series.md)
- [Setting up dashboard subscriptions](./dashboards/subscriptions.md)
## Models
......
......@@ -59,11 +59,12 @@ Whenever you change permissions for a group, make sure you:
## Further reading
- [Managing people and groups](04-managing-users.md)
- [Permissions guide][permissions] in Learn Metabase
- [Permissions guide][permissions]
- [Troubleshooting permissions][troubleshooting-permissions]
[collections]: 06-collections.md
[dashboard-subscriptions]: ../users-guide/dashboard-subscriptions.md
[dashboard-subscriptions]: ../dashboards/subscriptions.md
[data-permissions]: data-permissions.md
[pulses]: ../users-guide/10-pulses.md
[data-sandboxing]: ../enterprise-guide/data-sandboxes.md
[permissions]: /learn/permissions/
......
......@@ -66,7 +66,7 @@ A personal collection works just like any other collection except that its permi
[collections]: 06-collections.md
[collection-permissions]: /learn/permissions/collection-permissions.html
[dashboard-subscriptions]: ../users-guide/dashboard-subscriptions.md
[dashboard-subscriptions]: ../dashboards/subscriptions.md
[data-permissions]: data-permissions.md
[pulses]: ../users-guide/10-pulses.md
[data-sandboxing]: ../enterprise-guide/data-sandboxes.md
......@@ -76,4 +76,4 @@ A personal collection works just like any other collection except that its permi
[sandbox-rows]: /learn/permissions/data-sandboxing-row-permissions.html
[slack-integration]: 09-setting-up-slack.md
[sql-snippet-folders]: ../enterprise-guide/sql-snippets.md
[table-permissions]: data-permissions.md#table-permissions
\ No newline at end of file
[table-permissions]: data-permissions.md#table-permissions
......@@ -87,4 +87,4 @@ In Metabase, click on the **Save changes** button and that’s it! Metabase will
There are a few other settings you configure in Metabase. [Learn how](08-configuration-settings).
[dashboard-subscriptions]: ../users-guide/dashboard-subscriptions.html
\ No newline at end of file
[dashboard-subscriptions]: ../dashboards/subscriptions.md
......@@ -14,7 +14,7 @@ An important distinction to keep in mind is the difference between Metabase and
### Parameters
Some dashboards and questions have the ability to accept [parameters](../users-guide/13-sql-parameters). In dashboards, these are synonymous with [dashboard filters](../users-guide/08-dashboard-filters). For example, if you have a dashboard with a filter on `Publisher ID`, this can be specified as a parameter when embedding, so that you could insert the dashboard filtered down to a specific `Publisher ID`.
Some dashboards and questions have the ability to accept [parameters](../users-guide/13-sql-parameters). In dashboards, these are synonymous with [dashboard filters](../dashboards/filters.md). For example, if you have a dashboard with a filter on `Publisher ID`, this can be specified as a parameter when embedding, so that you could insert the dashboard filtered down to a specific `Publisher ID`.
SQL-based questions with template variables can also accept parameters for each variable. So for a query like:
......@@ -159,4 +159,4 @@ Paid plans include additional features for [customizing the appearance](../enter
## Further reading
- [Embedding track](/learn/embedding) in Learn Metabase.
\ No newline at end of file
- [Embedding track](/learn/embedding) in Learn Metabase.
......@@ -41,7 +41,7 @@ Monitoring access sets permissions on the following Admin tabs:
This setting determines who can set up:
- [Dashboard subscriptions](../users-guide/dashboard-subscriptions.md)
- [Dashboard subscriptions](../dashboards/subscriptions.md)
- [Alerts](../users-guide/15-alerts.md)
People will need to be in groups with either view or edit access to the collection that contains the dashboard or question in order to set up alerts. See [Collection permissions](06-collections.md).
\ No newline at end of file
People will need to be in groups with either view or edit access to the collection that contains the dashboard or question in order to set up alerts. See [Collection permissions](06-collections.md).
---
title: Dashboard filters
redirect_from:
- /docs/latest/users-guide/08-dashboard-filters
---
# Dashboard filters
![Dashboard Filters](images/dashboard-filters/dashboard-filters.png)
![Dashboard Filters](./images/filters.png)
Have you ever found yourself in a situation where it seems like you need to create nearly identical copies of the same dashboard, with just one different variable? Maybe you have an Earnings dashboard, but you want to see the data for each city your business is in, or maybe you have a KPI dashboard that you want to see broken out by month.
......@@ -14,7 +16,7 @@ Instead of creating duplicate dashboards, you can use dashboard filters to creat
To add a filter to a dashboard, first click the **pencil icon** to enter dashboard editing mode, then click the **Add a Filter** button that appears in the top-right.
![Add a Filter](images/dashboard-filters/01-add-filter.png)
![Add a Filter](./images/add-filter.png)
You can choose from a number of filter types:
......@@ -55,23 +57,23 @@ The ID filter provides a simple input box where you can type the ID of a user, o
The Other Categories filter is a flexible filter type that will let you create either a dropdown menu or an input box to filter on any category field in your cards.
**Note:** If you're trying to filter Native/SQL questions, you'll need to [add a bit of additional markup to your query](13-sql-parameters.md) in order to use a dashboard filter with that question. For an in-depth article on this, check out [Adding filters to dashboards with SQL questions](https://www.metabase.com/learn/dashboards/filters.html).
**Note:** If you're trying to filter Native/SQL questions, you'll need to [add a bit of additional markup to your query](../users-guide/13-sql-parameters.md) in order to use a dashboard filter with that question. For an in-depth article on this, check out [Adding filters to dashboards with SQL questions](https://www.metabase.com/learn/dashboards/filters.html).
## Example filter
Let's add a filter widget to our dashboard. We'll select a **Time** filter, and then select the **Month and Year** option.
![Choose filter type](images/dashboard-filters/02-filter-type.png)
![Choose filter type](./images/filter-type.png)
Metabase will display a filter editing interface where you can wire up your new filter to each applicable card.
![Wiring up the cards](images/dashboard-filters/03-wiring-cards.png)
![Wiring up the cards](./images/wiring-cards.png)
Each card will feature a dropdown menu where you can select the column to filter. The sidebar on the right displays the settings for the current filter. If there’s a card on your dashboard that you don’t want to use with the filter, or that doesn’t make sense to use with the filter, that’s okay — the filter will only be applied to the cards you select.
So here’s what we’re doing — when we pick a month and year with our new filter, the filter needs to know which column in the card to filter on. For example, if we have a **Total Orders** card, and each order has a `Date Ordered` as well as a `Date Delivered` column, we have to pick which of those columns to filter — do we want to see all the orders _placed_ in January, or do we want to see all the orders _delivered_ in January? So, for each card on our dashboard, we’ll pick a date column to connect to the filter. If one of your cards says there aren’t any valid columns, that just means that card doesn’t contain any columns that match the kind of filter you chose.
![Select fields](images/dashboard-filters/04-select-fields.png)
![Select fields](./images/select-fields.png)
Before we **Save** our changes, we can use the right sidebar to customize the **Label** of our new filter, or set a **Default value**.
......@@ -88,27 +90,27 @@ When you're finished wiring up the filter, click **Done** at the bottom of the s
Once you’ve added a filter to your dashboard, just click on the filter to select a value and activate the filter. To stop filtering, just click the blue X.
![Using a filter](images/dashboard-filters/08-use-filter.png)
![Using a filter](./images/use-filter.png)
You can also set up a dashboard question to [update a filter on click](interactive-dashboards.md#use-a-chart-to-filter-a-dashboard).
You can also set up a dashboard question to [update a filter on click](./interactive.md#use-a-chart-to-filter-a-dashboard).
## Choosing between a dropdown or autocomplete for your filter
If the column you're using for a filter has more than 100 unique values, you'll now automatically see a search box with autocomplete suggestions:
![Autocomplete](images/dashboard-filters/autocomplete.png)
![Autocomplete](./images/autocomplete.png)
Columns with fewer than 100 distinct values will list all options:
![List](images/dashboard-filters/list.png)
![List](./images/list.png)
In both cases, you can pick one or multiple selections for your filter.
![Multi-select](images/dashboard-filters/multi-select.png)
![Multi-select](./images/multi-select.png)
If Metabase somehow picked the wrong behavior for your field, admins can go to the [Data Model](../administration-guide/03-metadata-editing.md) section of the admin panel and click on the **gear** icon by the field in question to specify a list, search box, or plain input box.
![Search options](images/dashboard-filters/search-options.png)
![Search options](./images/search-options.png)
## Linking filters
......@@ -118,11 +120,11 @@ Say you have two filters, one to filter by state, the other to filter by city. Y
To link filters, you'll need to set up this parent-child relationship. And you set up this relationship through the child filter. In the above scenario, with a state and city filter, we'd edit the child filter, city, by clicking on the **gears** icon on the city filter. From the filter sidebar on the right, select the **Linked filters** tab.
![Linked filters](images/dashboard-filters/linked-filter.png)
![Linked filters](./images/linked-filter.png)
Here you can limit the current filter's choices. If you toggle on one of these dashboard filters, selecting a value for that filter will limit the available choices for this filter. In this case, we toggle on the state filter (the parent), to limit the choices for the city filter. When states are selected, the city filter will limit its choices to cities in those states. Click **Done**, then **Save** to save the dashboard.
To learn more, check out [Linking filters in dashboards](https://www.metabase.com/learn/building-analytics/dashboards/linking-filters.html).
To learn more, check out [Linking filters in dashboards](https://www.metabase.com/learn/dashboards/linking-filters.html).
## Best practices
......@@ -134,6 +136,8 @@ Here are a few tips to get the most out of dashboard filters:
## Further reading
- [Dashboards intro](07-dashboards.md)
- [Interactive dashboards](interactive-dashboards.md)
- [Introduction to dashboards](./introduction.md)
- [Interactive dashboards](./interactive.md)
- [Dashboard subscriptions](./subscriptions.md)
- [Charts with multiple series](./multiple-series.md)
- [Learn dashboards](/learn/dashboards)
docs/dashboards/images/dashboard.png

245 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment