DashboardBuilder Class

Contains methods that allow you to customize the Web Dashboard.

Namespace: DevExpress.DashboardAspNetCore

Assembly: DevExpress.Dashboard.v24.1.AspNetCore.dll

NuGet Package: DevExpress.AspNetCore.Dashboard

Declaration

C#

public class DashboardBuilder :
    IHtmlContent

VB.NET

Public Class DashboardBuilder
    Implements IHtmlContent

Related API Members

The following members return DashboardBuilder objects:

Show 32 links

• BuilderFactoryExtension.Dashboard(BuilderFactory, String)
• BuilderFactoryExtension.Dashboard(BuilderFactory)
• DashboardBuilder.AllowMaximizeItems(Boolean)
• DashboardBuilder.BackendOptions(Action<DashboardBackendOptionsBuilder>)
• DashboardBuilder.ControllerName(String)
• DashboardBuilder.DataRequestOptions(Action<DataRequestOptionsBuilder>)
• DashboardBuilder.EncodeHtml(Boolean)
• DashboardBuilder.Extensions(Action<DashboardExtensionsOptionBuilder>)
• DashboardBuilder.Height(Int32)
• DashboardBuilder.Height(String)
• DashboardBuilder.InitialDashboardId(String)
• DashboardBuilder.InitialDashboardState(String)
• DashboardBuilder.LimitVisibleDataMode(LimitVisibleDataMode)
• DashboardBuilder.LoadDefaultDashboard(Boolean)
• DashboardBuilder.Name(String)
• DashboardBuilder.Nonce(String)
• DashboardBuilder.OnBeforeRender(String)
• DashboardBuilder.OnDashboardBeginUpdate(String)
• DashboardBuilder.OnDashboardEndUpdate(String)
• DashboardBuilder.OnDashboardInitialized(String)
• DashboardBuilder.OnDashboardInitializing(String)
• DashboardBuilder.OnDashboardStateChanged(String)
• DashboardBuilder.OnInitializing(String)
• DashboardBuilder.OnItemBeginUpdate(String)
• DashboardBuilder.OnItemEndUpdate(String)
• DashboardBuilder.ResizeByTimer(Boolean)
• DashboardBuilder.ShowConfirmationOnBrowserClosing(Boolean)
• DashboardBuilder.UseCardLegacyLayout(Boolean)
• DashboardBuilder.UseNeutralFilterMode(Boolean)
• DashboardBuilder.Width(Int32)
• DashboardBuilder.Width(String)
• DashboardBuilder.WorkingMode(WorkingMode)

Remarks

The code below shows how to customize the Web Dashboard by calling the Dashboard method in the View. The Width(Int32), Height(Int32), and WorkingMode(WorkingMode) methods are used in this example to configure the Web Dashboard. The code snippet also shows how to handle the DashboardControl‘s events and set the initial values for the extension options.

<div style="position: absolute; left: 0; top: 0; right: 0; bottom: 0;">
@(Html.DevExpress().Dashboard("dashboardControl1")
    .ControllerName("DefaultDashboard")
    .Width("100%")
    .Height("100%")
    .OnBeforeRender("onBeforeRender")
    .OnDashboardInitializing("onDashboardInitializing")
    .Extensions(ext => {
        ext.DataInspector(opt => {
            opt.AllowInspectAggregatedData(true);
        });
        ext.DashboardExport(opt => {
            opt.AllowExportDashboard(true);
        });
    });
)
</div>

Inheritance

Object

DashboardBuilder