Skip to content
Snippets Groups Projects
Commit 41178bd2 authored by Maz Ameli's avatar Maz Ameli
Browse files

Add images to dashboard filters doc.

parent 221fb070
No related branches found
No related tags found
No related merge requests found
Showing
with 21 additions and 1 deletion
## Dashboard Filters
![Dashboard Filters](images/dashboard-filters/dashboard-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.
Instead of creating duplicate dashboards, you can use Metabase’s dashboard filters feature to create simple toggles to change a variable for all the cards on a dashboard.
### Adding a new filter
To add a filter to a dashboard, first enter dashboard editing mode, then click the Add a Filter button that appears in the top-right. You can choose from a number of filter types: time, location, ID, or other categories. The type of filter you choose will determine what the filter widget will look like, and will also determine what fields you’ll be able to filter your cards by. Let’s try a time filter, and then select the Month and Year option.
To add a filter to a dashboard, first 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)
You can choose from a number of filter types: time, location, ID, or other categories. The type of filter you choose will determine what the filter widget will look like, and will also determine what fields you’ll be able to filter your cards by. Let’s try a time filter, and then select the Month and Year option.
![Choose filter type](images/dashboard-filters/02-filter-type.png)
Now we’ve entered a new mode where we’ll need to wire up each card on our dashboard to our new filter. If there’s a card on your dashboard that you don’t want to use with the filter, or that it doesn’t make sense to use with the filter, that’s okay — it’ll just fade out when you use the filter.
![Wiring up the cards](images/dashboard-filters/03-wiring-cards.png)
So here’s what we’re doing — when we pick a month and year with our new filter, the filter needs to know which field 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`, we have to pick which of those fields 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 field to connect to the filter. If one of your cards says there aren’t any valid fields, that just means that card doesn’t contain any fields that match the kind of filter you chose.
![Select fields](images/dashboard-filters/04-select-fields.png)
Before we click the `Done` button at the top of the screen, we can also customize the label of our new filter by clicking on the pencil icon next to it. We’ll type in a new label and hit enter. Now we’ll click `Done`, and then save the changes to our dashboard with the `Save` button.
![Edit the filter label](images/dashboard-filters/05-edit-label.png)
You can add multiple filters to your dashboard following the same steps. We just recommend that you try to stick to just two or three of them for a single dashboard so you don’t confuse your users.
### Editing a filter
To edit a filter, enter dashboard editing mode, then click the `Edit` button on the filter you want to change. You an also click `Remove` to get rid of a filter. If you do this by accident, just click `Cancel` in the top-right to exit dashboard editing mode without saving your changes.
![Edit or remove a filter](images/dashboard-filters/06-edit-and-remove.png)
### Setting a default value
If you want one of your filters to start with a default value when you load the dashboard it’s in, while in filter editing mode just click on the filter to select a value. Click the blue X if you want to remove the default value.
![Set a default value](images/dashboard-filters/07-default-value.png)
### Using filters
Once you’ve added a filter to your dashboard, just click on it to select a value and activate the filter. To stop filtering, just click the blue X. To change the filter, click anywhere else on it.
![Using a filter](images/dashboard-filters/08-use-filter.png)
### Best practices
Here are a few tips to get the most out of dashboard filters:
......
docs/users-guide/images/dashboard-filters/01-add-filter.png

63.7 KiB

docs/users-guide/images/dashboard-filters/02-filter-type.png

72.2 KiB

docs/users-guide/images/dashboard-filters/03-wiring-cards.png

181 KiB

docs/users-guide/images/dashboard-filters/04-select-fields.png

22.9 KiB

docs/users-guide/images/dashboard-filters/05-edit-label.png

9.6 KiB

docs/users-guide/images/dashboard-filters/06-edit-and-remove.png

11.3 KiB

docs/users-guide/images/dashboard-filters/07-default-value.png

64 KiB

docs/users-guide/images/dashboard-filters/08-use-filter.png

12.1 KiB

docs/users-guide/images/dashboard-filters/dashboard-filters.png

52.4 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