TdxCustomDashboardControl Class

The base class for the VCL Dashboard control.

Declaration

TdxCustomDashboardControl = class(
    TdxWebBrowser
)

Remarks

TdxDashboardControl is a visual 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 embedded into one self-contained EXE file transparently.

VCL Dashboards: A Dashboard Content Example

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.

Bind to Data

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 data connection class descriptions for detailed information and code examples.

Data Connection Components

TdxBackendInMemoryJSONConnection: A component designed for interaction with data stored in memory.
TdxBackendDataSetJSONConnection: A component designed to work with data in one or multiple datasets (TDataSet descendants).
TdxBackendDatabaseSQLConnection: A component designed to fetch data from an SQL database (SQL Server, PostgreSQL, SQLite, etc.).

Tip
This component relies on our ASP.NET Core Reporting engine based on the XPO ORM (powered by ADO.NET). Refer to the following topic for connection string examples: Specify a Connection String.

Main API Members

The list below outlines key members of the TdxCustomDashboardControl class. These members allow you to configure and manage templates as well as export dashboard content in different target formats.

Dashboard Content and Layout

Clear: Clears the dashboard control.
DashboardName: Specifies the dashboard name (for template/layout management and content export).
Language: Allows you to switch between available UI and content localizations.
Layout: Provides access to the dashboard template (as individual XML strings).
OnLayoutChanged: Allows you to respond to any dashboard layout changes.

End-User Interaction

ExportFormats: Specifies export formats available to users.
ShowDesigner | ShowViewer: Display Web-based Dashboard Designer and Dashboard Preview dialogs. Global skin and palette settings (defined using the Project Settings dialog or a TdxSkinController component) affect these dialogs.

Data Export

ExportTo: Exports the current dashboard to a file or stream in any supported format.
ExportToCSV | ExportToPDF | ExportToXLS | ExportToXLSX: Export the current dashboard to a stream in corresponding document formats.
ExportToGIF | ExportToJPG | ExportToPNG | ExportToSVG: Export the current dashboard to a stream in corresponding image formats.
OnStateChanged: Allows you to respond to any user interaction state changes.
State: Provides access to the dashboard/user interaction state.

Terminal TdxCustomDashboardControl Class Descendant

Do not use the TdxCustomDashboardControl class directly. Use the TdxDashboardControl component instead.

To see the TdxDashboardControl component in action, run the BI Dashboards Designer/Viewer demo in the VCL Demo Center installed with compiled VCL DevExpress demos. Click different items in the sidebar on the left to switch between demo features.

Download: Compiled VCL Demos

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\