Hidden Dashboard Parameters
- 3 minutes to read
Hidden parameters allow your application to filter or transform dashboard data programmatically. In addition, hidden parameters protect application-supplied values (such as internal record IDs or application context) from accidental changes.
A hidden parameter does not appear in the Dashboard Parameters dialog but its value remains available to dashboard tile filters and queries and calculated fields.
Important
Hidden parameters are not secure storage. Dashboard and application code can access their values. Do not store passwords, access tokens, or other sensitive data in hidden parameters.
Use the TdxDashboard.Parameters/TdxCustomDashboardControl.Parameters collection to find a parameter by name, read or assign its value, or change the parameter’s visibility at runtime.
For parameter access methods and a code example, refer to the following help topic section: Access Parameters in Code.
Hide a Parameter
- Create a new dashboard parameter or open an existing parameter in the Dashboard Designer.
Clear the Visible option:
Specify default parameter values.
- Save the parameter.
Related Tutorial
The following tutorial creates a parameter, assigns its value, and passes the value to a data source:
- Follow this tutorial to create an application that obtains data from a stored database procedure and passes a dashboard parameter as a procedure parameter.
Related GitHub-Hosted Sample Projects
This section lists all public GitHub repositories (DevExpress-Examples) that demonstrate primary usage scenarios for dashboard parameters:
- This example filters dashboard data by country name.
- This example displays sales data for a selected country. The country is passed to the underlying SQL query as a hidden dashboard parameter.
Related Compiled Demo
To see the dashboard export functionality in action, run the BI Dashboards Designer/Viewer demo in the VCL Demo Center installed with compiled DevExpress VCL demos. Select any demo in the sidebar on the left, click the Export button, and use any export option listed in the menu.
Compiled DevExpress demos ship with source code installed in the Public Documents folder (%PUBLIC%) for all users (default). You can find all project and source code files for the BI Dashboards Designer/Viewer demo in the following folder:
%PUBLIC%\Documents\DevExpress VCL Demos\MegaDemos\Product Demos\ExpressDashboards\
Tip
Project and source code files for all compiled DevExpress VCL Demos are maintained in a public repository hosted on GitHub: