Configure the HierarchyFilter

So we managed to prepare our datasheet for the dimensional data model with the Hierarchy structure we want to use. We also set up a dashboard containing the HierarchyFilter extension. The next thing we need to do is configure the extension to use/visualize the hierarchy and make the dashboard interactive.

To enter the configuration screen, click on the "Configuration" button in the extension. alternatively, select the container of the HierarchyFilter extension and from the dropdown context menu select “Configure” as shown in the image below (click to enlarge).

Configuration wizard

A configuration menu will pop up. The configuration consists of wizard-like steps, indicated at the top of the screen. This is shown in the example below.

Configuration page 1

In this part of the Product Guide we discussed the dimensional model so we select the (default option) “Dimensional” from the startscreen of the configuration wizard. Now when we press “Next” we move on to connecting the extension to the datasheet. In the screen below you see the second step of the wizard.

Configuration page 2

First you select the “Dimensional dataset” sheet containing our Hierarchy data. The extension will read its content. From the second dropdown you select the ID column which we named “Product-ID”. It is important to fill the third field with the separator we used to separate the dimensions of our hierarchy. In this example we used the PIPE symbol “|”, the vertical line. The bottom part of this wizard screen shows the dimensions that were detected by the extension. You can choose which extensions you want to use in your Hierarchy Filter, we selected “All” dimensions that are in our Hierarchy datasheet.

In the blue info box the correct value of the calculation field is shown, please check if the value in your calculation field is the same.

Next step of the configuration we will set the interactions and connect to the parameters we created.

Configuration page 3

Everything on this page is optional. In the top section of the page, you can select parameters for your columns and some other metadata. This includes the ID, the name/label and the level depth starting from 1 with the highest parent(s). Your parameters will store the information of the selected marks in the HierarchyFilter extension. This way you can use the information of the selected node(s) in your Hierarchy filter in the rest of your dashboard using these parameters in your calculations and configurations.

Below the parameter selection are some options for sheet interaction:

• Filter: Filters the rows on the data sheet when selecting nodes in the tree. (to use this, a filter needs to be set up on the Calculated field).

• Mark selection: Selects mark of rows of the data sheet when selecting node(s) in the tree. This is used to filter on the rest of the dashboard.

• Enable dashboards filters to filter the hierarchy tree: This option allows other filters and selections on the dashboard filter the hierarchy tree.

• Multi-selection: Allows users of the tree to select multiple nodes at once by holding down control/command on the keyboard.

• Reload hierarchy tree when selected parameter(s) change: When this option is selected, a list of all parametes will be shown below. Each parameter that is selected, wil be listened to. If the selected parameter changes, the tree will be reloaded.

Configuration page 4

This page is divided in three tabs.

General tab

In the first tab there are some general options to show/hide the search bar, buttons, tooltips and the title. The lazy loading option only loads visible parts of the hierarchy tree. This improves the performance significantly.

Next, using a string parameter, you can use the “Persist State” setting to set up HierarchyFilter to remember the current selection when moving between dashboards. The state is meaning the collapsed and uncollapsed layout and the selected node. While using the dashboard, the parameter will update to maintain the current state. When opening a new instance of the dashboard (different user, platform, etc), the parameter will open in the state it was in at the time the workbook was published. When loading the dashboard from scratch, the parameter (and thus the state) will be based on the state of HierarchyFilter at the moment the workbook was published.

Styling tab

The styling tab lets you customize the look of your tree. To change the font, the "use tableau font settings must be enabled. The extension will then use the font and text color of your workbook. which you can change with the settings of Tableau.

Formatting tab

The last tab can be used to configure conditional formatting for your tree. This means that you can change the style of nodes based on the value of anything in the same row in the sheet.

First you need to select a numeric value column that will be used to determine if the target column should change its style. The value column needs to be placed as a detail on the sheet. you don't need to select it as a hierarchy field in page 2.

The target column wil be colored and will need to be one of the selected hierarchy fields on page 2.

After that, the bounds and colors for anything beyond the bounds need to be chosen.

Once you’re satisfied with all the options you can press “Submit” and your configuration is done configuring your HierarchyFilter with the Dimensional model. You should see something like the image below and you can start exploring your hierarchy and enjoy the interactivity.

Selected Pills

When selecting a pill the chosen pill will be shown in the overview, helping users to see which filter(s) are live. Holding CTRL for windows and command for mac will allow users to select multiple items. Deselecting or hitting the X on the pill will deselect the filter.