Overview
Filters enable reports on your dashboards to be filtered by a set of values. For example, a region filter will allow you to consume region-specific data on the same dashboard. KPI Studio allows the use of single filters, as well as filter groups. Note that filter groups cannot be used with horizontal filter widgets.
For filters to work on your dashboard, you must add reports with user-prompt filters. These filters can be used via the left side navigation filter panel. However, filter widgets can also be used to add filters to the global content containers, or anywhere on the dashboard canvas.
Filter widgets
Filters are added to the dashboard with a filter widget. Access the filter widget by clicking on the Filters button on the left side of the dashboard.
The following types of filter widgets are available:
- Horizontal Filter List: Displays the filter on your dashboard in a horizontally aligned layout.
- Vertical Filter List: Displays the filter on your dashboard in a vertically aligned layout.
The table below highlights the compatibility of each filter widget with filter types and dashboard layout options.
Feature compatibility | Horizontal filter list widget | Vertical filter list widget |
|---|---|---|
| Single filters | Yes | Yes |
| Filter groups | No | Yes |
| Canvas dashboard layout | Yes | Yes |
| Static dashboard layout | No | Yes |
| Global | No | Yes |
Left side navigation filters
Filters can also be added to dashboards without the use of a widget by using the left side navigation filters. This provides users with an alternate style of displaying filters in a slide out panel, rather than permanently displaying them on the dashboard.
To add a left side navigation filter, click on the top filter button on the left side of the screen to access a list of filters to be added directly to the dashboard.
Note that to see this left side navigation filter button, the Left Filters toggle in a dashboard properties panel must be enabled.
Global Filters
Vertical filter list widgets can be added to the left or right side content containers (i.e. on either side of the dashboard canvas or layout tab), or into the canvas tab (i.e. the middle section).
Those added to the side content containers can be considered ‘global filters’, as they will be visible for all sub tabs. However, you can also choose to add filters to the side containers without making them appear globally by turning off their respective Global settings.
Filter widgets added to the canvas (i.e the middle section) will only be visible for that sub tab.
Note: this does not affect actual filter functionality, all linked filters in a dashboard will still work globally regardless of which sub tab or side content container they are in, meaning that linked reports will get updated according to a filter selection.
Filter panel
You can add a single filter or filter groups to a filter panel through the filter widget. (See tutorial on how to add here). Once added, filters will display in the panel available for dashboard builders and end users to use on the dashboard.
The diagram and table below provide a basic understanding of a filter panel.
Number | Feature | Description |
|---|---|---|
1 | Drag filter panel | Click and drag this icon to move the filter panel to another location. |
| 2 | Remove filter panel | Click on this button and select Delete to delete the filter panel. |
| 3 | Link Filters | This button allows you to open set up for manually linking all or multiple filters. (A separate option is available to link individual filters.) Learn more. |
| 4 | + Filters | This button allows you to add user prompt report filters to the filter panel. Options include adding individual filters, or a filter group. |
| 5 | Individual Filter menu | Brings up a menu for the selected filter. Option includes:
|
| 6 | Select All | Enables users to select all filter options in a list filter. This appears only if you have a list. |
| 7 | Filter | The filter(s) added to this panel. Select a filter value or 'all' using the toggle. |
| 8 | Re-order filter | Use this icon to drag or move a filer above or below another. |
| 9 | Apply | Allows you to apply selected filter values. |
| 10 | Reset filter | Removes selected filter values to reset filters to their default values or no selection. |
| 11 | Refresh cached filters | Clicking this button refreshes the cached filter values, but it does not re-run the report (see Apply below). Note that this button will only appear if your filter contains cached values. |
Features 9 10, and 11 together make up the filter control. These appear below the Filters label by default, to be used by dashboard users.
How to use a Filter Widget
This tutorial shows how to add filters to a dashboard using a Filter Widget. Before you begin, add reports that contain user prompt filters to your dashboard.
- Log in to the LSAC application as an authorized user.
- Open KPI Studio from My Apps tab in the platform left navigation bar.
- Click the plus sign that appears at the top right corner of the window and select Dashboard.
- Select the Filters tab that appears on the left navigation pane to bring up the Filter Widget list.
- Then drag a Filter Widget onto the dashboard at the exact location you would like to display the filter. This includes anywhere on the dashboard canvas, or within any of the global content containers (essential for global filter lists).
- A filter panel will appear on the location it was dropped. (Side note: click here for an overview of this filter panel).
- Click + Filters to add report filters to this panel.
- Choose Filter to add individual filters (you can add multiple as well), or Filter Group to add a filter group. (In our example, we will choose Filter.)
- A pop up displaying available report filters will appear. This allows you to choose which filters to add from any of the reports.
Note: The filters in this popup are categorized, first according to the dashboard sub tab, and then reports within the tab.
Note 2: If none of the reports contain any filters, then the following notification will appear on this popup. Click the Add a report link to open the Reports tab on the left side.
- Click on one or more filter checkboxes to select those that you want to add. Alternatively, enable the Select All toggle to select all the filters on this pop up. You can undo this selection by enabling Clear All.
- Click Save that appears at the bottom of the pop-up to add the filters.
- The filters will then appear in the filter panel on the dashboard, as shown in the example below.
Add filter default values
You can set default values for your dashboard filters.
Change filter entry display
Filter entries or values will appear on dashboards with the display style applied on them in the report. However, the entry display type of certain filters can be changed in the Dashboard builder, without having to change it in the report first. Entry styles can be changed to checkboxes, lists, pop-ups, drop downs or radio buttons, depending on the filter type.
This is possible if the report filter meets all of the following criteria:
- The filter is formatted to display its values in the form of a list. Ensure that the Value Entry Method of the filter is selected as ‘Value List Selection’ in the report.
- The filter is not a date filter with predefined or cached values.
How to change:
- Add the filters using the Filter Widget.
- Click on the ellipses button on an individual filter to bring up its menu, and select Entry Style.
- Choose the new entry style from the list of options.
- The filter entries will be instantly updated.
Filter properties
The filter properties panel lets you configure the following settings.
Property name | Description |
|---|---|
Name | Name of the filter. This can be edited. This name appears in the dashboard code mode, making it easy to edit the filter code. |
| Auto height | Automatically adjusts the height of a filter widget according to the items in it. Turn off to manually define the filter height in a text box. This option is only available if a filter widget is added to a static container. Note that the widget heights can also be changed by manually dragging the widget border, in which case this option will get switched off. Note that this option is not available for horizontal filter list widgets. |
Height | Height of the filter in pixels. This is available if the Auto Height option is turned off. Note that this option is not available for horizontal filter list widgets. |
Global | Enable this toggle to make your filter lists globally available. Global filters are present for all sub tabs in the dashboard. So if disabled, this filter will only be available for a specific sub tab. Note that this option only works for vertical filter list widgets positioned on the left or right global content containers, not filters added to a dashboard content area. |
Hide reset link | Allows you to hide the filter reset option. |
| Hide display name | Allows you to hide the filter display name. |
| Display name | Display name of the filter that appears on the filter panel. This can be edited. |
Hide control panel | Allows you to hide control buttons on a filter panel for the end user. These include bookmark, reset, and apply buttons. Dashboard users will not be able to use these filter features. |
| Auto run filters | Enable this toggle to automatically run reports when filter values are selected or changed, without using the ‘Apply’ button. Administrators can also set a time delay, where the reports are run after a specified time once values are selected. This is done through the Content Settings > Report Settings > Builder Setting > Filter Run Delay setting. |
| List Size | Allows you to set the number of values displayed in the list before scrolling is required. If a list contains fewer values than this number, the list size will shrink to fit accordingly. |
| Apply button location | Allows you to specify the location of the filter control panel, including the 'Apply' button. You can choose to display the button and controls at the top or bottom of the filter panel, or in both locations. Note that this option is not available for horizontal filter list widgets. |
| Size & Location | |
X | Specify the x coordinates of the top left corner of the filter widget, in order to position it exactly on your dashboard canvas. |
Y | Specify the y coordinates of the top left corner of the filter widget, in order to position it exactly on your dashboard canvas. |
Width | Specify the width of the filter widget, in pixels, in order to resize it exactly. |
Height | Specify the height of the filter widget, in pixels, in order to resize it exactly. Note that this option is not available for horizontal filter list widgets. |
Corners | This option allows you to define the roundness of your filter widget border corners. Tip: For maximum circular edges, enter half the value of the widget height. For example, if the height is 400 pixels, then set the edge value to 200 pixels. Moreover, any value greater than 200 for the edge, will have no further effect in this example. |
Rotation | Specify the amount you wish to rotate your widget clockwise, in degrees. To rotate anti-clockwise, specify a negative value. Note that this option is not available for horizontal filter list widgets. |
Aspect ratio | Enable this toggle to maintain the aspect ratio. This means the widget maintains its shape, but its size can be increased or decreased. If this is disabled, the widget can be stretched out of shape either vertically or horizontally. |
Lock widget | Enable this toggle to lock the filter widget in its location. This stops you from moving or resizing the widget. This holds true even when selecting multiple widgets on the canvas. |
| Background Formatting | |
Background color | Allows you to specify a background color for the filter widget. |
Opacity | Allows you to specify the transparency of the background color on the widget. |
Customize padding | This option allows you to define a custom padding or buffer around the filter widget, in pixels. This includes padding for each side to the widget. If disabled, you can still define an overall padding size. |
Padding top | When custom padding is enabled, this allows you to define padding to be added to the top of the widget. |
Padding bottom | When custom padding is enabled, this allows you to define padding to be added to the bottom of the widget. |
Padding right | When custom padding is enabled, this allows you to define padding to be added to the right of the widget. |
Padding left | When custom padding is enabled, this allows you to define padding to be added to the left of the widget. |
Padding | This allows you to define an overall padding size for the filter widget. This size, defined in pixels will be constant on each side of the widget. To add different sized padding on any of the sides, enable the Customize Padding option. |
Border width | This allows you to specify the thickness of the widget border. Note: to make the widget border visible, you must define values for all three border properties. |
Border style | This allows you to select a style for the widget border. Options include: dashed, solid, dotted, groove, and more. |
Border color | This allows you to specify the color of the widget border. |
| Spread X | This option shifts the position of the shadow blur along the X axis, in pixels. |
| Spread Y | This option shifts the position of the shadow blur along the Y axis, in pixels. |
Shadow blur | This option allows you to define the sharpness of the shadow. The smaller the value, the sharper and more defined the shadow will be. For a blurry or softer shadow, provide a bigger value. |
Shadow color | This option allows you to set a color for the shadow. |
| Actions | |
| Click Event | Select an event that will trigger when the selected widget is clicked. Event options include:
|
| Report ID | If navigating to a report using the ‘Go to report’ click event, provide the UUID of the report. |
| Sub Tab # | If navigating to a sub tab using the ‘Go to sub tab’ click event, enter the order number of the sub tab. |
| URL | If navigating to an external page using the ‘Go to URL’ click event, provide the full URL of the page. |
| Target | If navigating to an external page using the ‘Go to URL’ click event, specify the page target. Options include:
|
Deleting filter reports
Filters added to the dashboard are created from a report. If that report is deleted, all of its filters and filter links will also be deleted from the dashboard. However users will be shown a warning to alert them to this.
Click Delete if you would like to continue to delete the report.