diff --git a/docs/users-guide/07-dashboard-filters.md b/docs/users-guide/07-dashboard-filters.md index bf6b8f93a928454892fceb67adf16df244d2b46a..d4965e39940f975e5c802bdf14da7693aadf891b 100644 --- a/docs/users-guide/07-dashboard-filters.md +++ b/docs/users-guide/07-dashboard-filters.md @@ -1,33 +1,53 @@ ## Dashboard Filters + + 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. + + + +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. + + 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. + + 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. + + 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. + + 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. + + ### 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. + + ### 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. + + ### Best practices Here are a few tips to get the most out of dashboard filters: diff --git a/docs/users-guide/images/dashboard-filters/01-add-filter.png b/docs/users-guide/images/dashboard-filters/01-add-filter.png new file mode 100644 index 0000000000000000000000000000000000000000..d98173a0055668a33febd66d7c754380fa80dbec Binary files /dev/null and b/docs/users-guide/images/dashboard-filters/01-add-filter.png differ diff --git a/docs/users-guide/images/dashboard-filters/02-filter-type.png b/docs/users-guide/images/dashboard-filters/02-filter-type.png new file mode 100644 index 0000000000000000000000000000000000000000..a4ca69c03825ef3046a5c78156000e768a864d7e Binary files /dev/null and b/docs/users-guide/images/dashboard-filters/02-filter-type.png differ diff --git a/docs/users-guide/images/dashboard-filters/03-wiring-cards.png b/docs/users-guide/images/dashboard-filters/03-wiring-cards.png new file mode 100644 index 0000000000000000000000000000000000000000..6d5da5ae148a1f3bfe2261b8bff9483b0efa2d89 Binary files /dev/null and b/docs/users-guide/images/dashboard-filters/03-wiring-cards.png differ diff --git a/docs/users-guide/images/dashboard-filters/04-select-fields.png b/docs/users-guide/images/dashboard-filters/04-select-fields.png new file mode 100644 index 0000000000000000000000000000000000000000..9d0d163b82735ad85983e0675fc587c0b14e404f Binary files /dev/null and b/docs/users-guide/images/dashboard-filters/04-select-fields.png differ diff --git a/docs/users-guide/images/dashboard-filters/05-edit-label.png b/docs/users-guide/images/dashboard-filters/05-edit-label.png new file mode 100644 index 0000000000000000000000000000000000000000..d713a15d3b3883ab21d839ca6ba0430c76d41aac Binary files /dev/null and b/docs/users-guide/images/dashboard-filters/05-edit-label.png differ diff --git a/docs/users-guide/images/dashboard-filters/06-edit-and-remove.png b/docs/users-guide/images/dashboard-filters/06-edit-and-remove.png new file mode 100644 index 0000000000000000000000000000000000000000..c516ae9bc7fa5cc4fccdafcb733e7c15568ffc9d Binary files /dev/null and b/docs/users-guide/images/dashboard-filters/06-edit-and-remove.png differ diff --git a/docs/users-guide/images/dashboard-filters/07-default-value.png b/docs/users-guide/images/dashboard-filters/07-default-value.png new file mode 100644 index 0000000000000000000000000000000000000000..4c1cb8c42d85ca4d5e7cd55cfca56ba5e0e2d8e4 Binary files /dev/null and b/docs/users-guide/images/dashboard-filters/07-default-value.png differ diff --git a/docs/users-guide/images/dashboard-filters/08-use-filter.png b/docs/users-guide/images/dashboard-filters/08-use-filter.png new file mode 100644 index 0000000000000000000000000000000000000000..ffc895a3477c86bb786237fdb4daea8449cb1c16 Binary files /dev/null and b/docs/users-guide/images/dashboard-filters/08-use-filter.png differ diff --git a/docs/users-guide/images/dashboard-filters/dashboard-filters.png b/docs/users-guide/images/dashboard-filters/dashboard-filters.png new file mode 100644 index 0000000000000000000000000000000000000000..600cf366846d13b8fc84d186c504aaa624aba8cd Binary files /dev/null and b/docs/users-guide/images/dashboard-filters/dashboard-filters.png differ