DxDashboard
Namespace: Wisej.Web.Ext.DxDashboard
Assembly: Wisej.Web.Ext.DxDashboard (4.1.0.0)
Represents a DevExpress Dashboard control (DevExpress.Dashboard.DashboardControl) that displays or designs dashboards provided by a DevExpress Dashboard backend.
- C#
- VB.NET
public class DxDashboard : Widget
Public Class DxDashboard
Inherits Widget
The Options are passed to the constructor of the client DashboardControl, and later changes are applied with its option() method.
The JavaScript and CSS files are loaded as specified in the Wisej.Web.Ext.DxDashboard.json configuration file, which is read from the root of the application, from the embedded resources of the application or of the assembly that subclasses the control, or from this extension, in this order. A valid license from DevExpress is required to use this integration.
Constructors
DxDashboard()
Constructs a new instance of the DxDashboard class.
Set the options of the client DashboardControl, such as the endpoint URL of the dashboard backend, in Options.
Example:
The following example creates a dashboard viewer connected to the dashboard backend of the application.
var dashboard = new DxDashboard();
dashboard.Dock = DockStyle.Fill;
dashboard.Options.endpoint = "/api/dashboard";
dashboard.Options.workingMode = "ViewerOnly";
this.Controls.Add(dashboard);
Properties
Theme
String: Returns or sets the theme for all the DxDashboard controls in the current session.
The value is the name of a DevExtreme theme, for example "light" or "dark", and replaces the %theme% placeholder in the CSS file names listed in the Wisej.Web.Ext.DxDashboard.json configuration file. When the value is null or empty, the theme value in the configuration file is used.
The value is stored in the session. Changing it reloads the packages of all the DxDashboard controls in the session and updates them.
Example:
The following example switches all the dashboards of the session to the dark theme.
DxDashboard.Theme = "dark";