vcl-dxdashboard-dot-control.md
A VCL Dashboard control.
TdxDashboardControl = class(
TdxCustomDashboardControl
)
TdxDashboardControl is a visual[1] component designed to display multiple interconnected data analysis UI elements within an automatically arranged layout. Interactive data analysis elements (dashboard visualization items) include grids, charts, maps, gauges, etc.
The VCL Dashboard implementation is based on the DevExpress JavaScript Dashboard Designer and Viewer for native VCL apps (using modern WebView and ASP.NET Core/JavaScript wrappers). All required .NET and JavaScript dependencies are transparently embedded into one self-contained EXE file.
Note
The ExpressDashboards Suite is available as a Community Technology Preview (CTP). Please review our pre-release software notes if you plan on using ExpressDashboards.
Ensure that your development environment meets ExpressDashboards and ExpressReports prerequisites:
Tip
Refer to the following topic for detailed information: VCL Reports/Dashboards App Deployment.
Dashboard visualization items created using the TdxDashboardControl component can display data from different sources stored in memory or a database. The TdxBackendDataConnectionManager component allows you to manage data connection components designed to work with different data sources.
Tip
You can create data connection components directly in code, without TdxBackendDataConnectionManager.
Refer to the data connection class descriptions for detailed information and code examples.
TdxBackendDataSetJSONConnection
A component designed to work with data in one or multiple VCL-compatible datasets (TDataSet descendants).
Use the TdxBackendDataSetJSONConnection component if you need to use TdxDashboardControl/TdxDashboard and TdxReport components together with VCL-compatible data sources.
Refer to the following help topic for step-by-step instructions on using the TdxBackendDataSetJSONConnection component in your project:
VCL Reports/Dashboards: How to Use Data Source and Data Set Components
TdxBackendInMemoryJSONConnection
A component designed for interaction with local (in-memory) or remote JSON data accessible through a Web API service endpoint.
Refer to the following help topic for step-by-step instructions on using the TdxBackendInMemoryJSONConnection component as a data source for TdxDashboard/TdxDashboardControl and TdxReport:
VCL Reports/Dashboards: How to Use Memory-Based or Remote API Data Sources
TdxBackendDatabaseSQLConnection
A DevExpress XPO-based component designed to fetch data from the following relational databases:
SQLite | Microsoft SQL Server/Azure SQL | PostgreSQL | Oracle Database | MySQL | Firebird
Tip
This component is based on the DevExpress XPO ORM engine (powered by ADO.NET).
TdxBackendDatabaseSQLConnection has built-in support for Microsoft SQL/Azure SQL and SQLite engines (you can use them without additional dependencies and extra configuration).
Refer to the following topic for a complete list of supported database engines and corresponding connection string examples:
VCL Reports/Dashboards: Supported Database Engines
The list below outlines key members of the TdxDashboardControl class. These members allow you to configure and manage templates as well as export dashboard content to different target formats.
ClearClears the dashboard control (name, layout definition, state, and parameters).DashboardNameSpecifies the dashboard name (for template/layout management and content export).EnableCustomSql
Specifies if custom SQL queries are enabled at the TdxDashboardControl component level.
Important
Enable custom SQL queries only if you ensure that you follow best practices and implement user read/write privileges at the database level using the tools available for your relational database management system.
LanguageAllows you to switch between available UI and content localizations.LayoutProvides access to the dashboard template (as individual XML strings).OnLayoutChangedAllows you to respond to any dashboard layout changes.Parameters
Provides access to the read-only collection of dashboard parameters.
Note
The Parameters collection is automatically populated and updated from the current dashboard layout definition.
ReloadDataReloads data from all underlying data sources on demand and updates dashboard content.
ExportFormatsSpecifies export formats available to users.OnExportAllows you to execute code in response to dashboard content download operations or to prevent users from downloading dashboard content as a file (in any supported format).OnDesignerFormShow | OnViewerFormShowAllow you to customize Dashboard Designer and Dashboard Viewer dialog form settings (position, dimensions, caption, etc.).OnStateChangedAllows you to respond to any user interaction state changes.ShowDesigner | ShowViewerDisplay the modal Web Dashboard dialog in Designer and Viewer modes. Global skin and palette settings (defined using the Project Settings dialog or a TdxSkinController component) affect these dialogs.StateProvides access to the dashboard/user interaction state.
ExportToExports the current dashboard to a file or stream in any supported format.ExportToCSV | ExportToPDF | ExportToXLS | ExportToXLSXExport the current dashboard to a stream in corresponding document formats.ExportToGIF | ExportToJPG | ExportToPNG | ExportToSVGExport the current dashboard to a stream in corresponding image formats.
View Example: Store Dashboard Layouts in a DatabaseView Example: Pass a Hidden Dashboard Parameter to a SQL Query
To see the TdxDashboardControl component in action, run the BI Dashboards Designer/Viewer demo in the VCL Demo Center installed with compiled DevExpress VCL demos. Click items on the left sidebar to switch between demo features.
Tip
You can find full source code for the installed compiled Report demo in the following folder:
_%PUBLIC%\Documents\DevExpress VCL Demos\MegaDemos\Product Demos\ExpressDashboards_
Show 11 items
TObject TPersistent TComponent TControl TWinControl TCustomControl TcxCustomControl TcxControl TdxWebBrowser TdxCustomDashboardControl TdxDashboardControl
Footnotes
See Also