Bind Parameters to Filters
This topic describes how to create a parameter and bind it to a filter or choose an existing parameter to bind to a filter.
About Binding Parameters to Filters
Bind a parameter to a filter when you want to pass a selected filter value from one canvas to another in a workbook, or you want to have more control over how filters behave and are exposed to the user.
Note:
You can bind a parameter to a list or range filter.Binding a parameter to a filter is one-way binding, meaning a parameter doesn't limit the list of available filter values that the user can choose from. A parameter's properties define the values that it can accept from the filter.
When bound to a filter, the parameter listens to the filter's selections and when the parameter accepts a filter value, it passes that value to wherever you use the parameter in the workbook.
Binding a parameter to a filter has many uses. For example, by default when you add the Dashboard Filters control to a canvas, it only applies filters to that canvas. You can use parameters bound to filters to pin the dashboard filters across multiple canvases in the workbook. When multiple canvases include a dashboard control with the same filters bound to the same parameters, any filter values selected by the user are applied to each canvas.
Create and Bind a Parameter to a Filter
Click a filter's Create Parameter option to create a parameter and bind it to the filter with one click.
Note:
You can bind parameters to list and range filters.Create and Bind a Parameter to a List Box Dashboard Filter
Because the list box filter doesn't include the Bind to Parameter option, you need to use the Create Parameter filter property to create and bind a parameter to a list box dashboard filter.
- On the Home page, select a workbook, click Actions, select Open, and click Edit.
- In the Data Panel, click the Visualizations tab, and drag and drop Dashboard Filters to the canvas.
- In the Data Panel, click the Data tab, and drag and drop the column that you want to use to filter the canvas.
- In the dashboard filter's Properties pane, click Properties, then click Filter Controls. Go to the Filter Type field and select List Box.
- In the Properties pane, go to Parameter Binding and click None.
- Select an existing parameter to bind to the filter, or click Create Parameter to use the selected filter values to create and bind the parameter to the list box filter.
- Optional: To specify if the user is required to select a filter value, go to the Properties pane, click the Selection Required field, and select On.
- Click Save.
Create and Bind a Parameter to a Double Column Type Filter
Click a double column type filter's Create Parameter option to create a parameter and bind it to the filter with one click.
- On the Home page, select the workbook where you want to create a double column type filter and add and bind a parameter to, click Actions, and then select Open.
- Create or locate and click the double column type filter where you want to create and bind the parameter. The filter displays the double column's display values and not its ID values.
- Click (x) and then click Create Parameter to create and bind the parameter to the filter.
- Optional: Go to the workbook's Data Panel, click Parameters, right-click the parameter you created from the filter, and select Edit Parameter to reviews and update the parameter's properties.
- Click OK.
Bind an Existing Parameter to a Filter
Choose a system parameter or an existing workbook parameter to bind to a filter and pass a selected filter value to the parameter.
Note:
You can bind parameters to list and range filters.![Compatability warning icon Compatability warning icon](img/param_list_warning_icon.png)
- On the Home page, select the workbook with the filter that you want to bind a parameter to, click the Actions menu, and then select Open.
- Create or locate and click the filter that you want to bind the parameter to.
- Click (x) and then click the parameter that you want to bind to the filter.
- Click OK.