DashboardExtensionsOptionBuilder.ViewerApi(Action<DashboardViewerApiOptionBuilder>) Method

Allows you to use the ViewerApi extension.

Namespace: DevExpress.DashboardAspNetCore

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

Declaration

C#

public DashboardExtensionsOptionBuilder ViewerApi(
    Action<DashboardViewerApiOptionBuilder> config
)

VB.NET

Public Function ViewerApi(
    config As Action(Of DashboardViewerApiOptionBuilder)
) As DashboardExtensionsOptionBuilder

Parameters

Name	Type	Description
config	Action<DashboardViewerApiOptionBuilder>	A delegate used to configure the DashboardViewerApiOptionBuilder.

Returns

Type	Description
DashboardExtensionsOptionBuilder	A reference to this instance after the operation has completed.

Remarks

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 => {
            // ...
        });
    })
)