DashboardViewerApiOptionBuilder Class

A wrapper that provides access to ViewerApiExtensionOptions.

Namespace: DevExpress.DashboardAspNetCore

Assembly: DevExpress.Dashboard.v23.2.AspNetCore.dll

NuGet Package: DevExpress.AspNetCore.Dashboard

Declaration

C#

public class DashboardViewerApiOptionBuilder

VB.NET

Public Class DashboardViewerApiOptionBuilder

Related API Members

The following members return DashboardViewerApiOptionBuilder objects:

Show 14 links

• DashboardViewerApiOptionBuilder.OnDashboardTitleToolbarUpdated(String)
• DashboardViewerApiOptionBuilder.OnItemActionAvailabilityChanged(String)
• DashboardViewerApiOptionBuilder.OnItemCaptionToolbarUpdated(String)
• DashboardViewerApiOptionBuilder.OnItemClick(String)
• DashboardViewerApiOptionBuilder.OnItemDrillDownStateChanged(String)
• DashboardViewerApiOptionBuilder.OnItemElementCustomColor(String)
• DashboardViewerApiOptionBuilder.OnItemMasterFilterStateChanged(String)
• DashboardViewerApiOptionBuilder.OnItemSelectionChanged(String)
• DashboardViewerApiOptionBuilder.OnItemVisualInteractivity(String)
• DashboardViewerApiOptionBuilder.OnItemWidgetCreated(String)
• DashboardViewerApiOptionBuilder.OnItemWidgetOptionsPrepared(String)
• DashboardViewerApiOptionBuilder.OnItemWidgetUpdated(String)
• DashboardViewerApiOptionBuilder.OnItemWidgetUpdating(String)
• DashboardViewerApiOptionBuilder.OnSelectedTabPageChanged(String)

Remarks

Use the DashboardExtensionsOptionBuilder.ViewerApi method to call the DashboardViewerApiOptionBuilder.

The code sample below shows how to configure the Web Dashboard’s viewer api extension:

@(Html.DevExpress().Dashboard("dashboardControl1")
    .Width("100%")
    .Height("100%")
    .OnBeforeRender("onBeforeRender")
    .Extensions(ext => {
        ext.ViewerApi(options => {
            // ...
        });
    })
)

Inheritance

Object

DashboardViewerApiOptionBuilder