Client-Side API Overview for ASP.NET Core Dashboard

  • 2 minutes to read

The Web Dashboard is a client-server control. On the client side, the Web Dashboard utilizes the DashboardControl to supply users with a UI to design and interact with a dashboard. You can use its API to specify settings on the client and send requests to the server. You can also specify some settings in a view.

Web Dashboard Client Architecture for Wrappers

Control Options

Use the DashboardBuilder options to configure the control in a view. The following code shows how to set the control’s width, height, and working mode:


Call the DashboardBuilder.Extensions method to access extension options. The code sample below shows how to get the ViewerApi extension and handle the ItemWidgetCreated event:

    .Extensions(ext => {
        ext.ViewerApi(options => {

The following function displays an alert window with the name of the dashboard item for which the event occurred:

    function displayItemName(e) {
        alert("The item name is " + e.itemName);

DashboardControl API

Handle the BeforeRender event to access the underlying DashboardControl.


The sender is the DashboardControl instance. The following code shows how you can remove the export extension, modify the Toolbox, and get the dashboard item data:

function onBeforeRender(sender) {
    var dashboardControl = sender;               


    var toolboxExtension = dashboardControl.findExtension("toolbox");

    var webViewerApi = dashboardControl.findExtension('viewer-api');
    var chartClientData = webViewerApi.getItemData("chartDashboardItem1");

See the following article for information on how you can customize the client: UI Elements and Customization.

See Also