StartupExtensions.MapXafDashboards(IEndpointRouteBuilder, String, String) Method

Registers the required Dashboards Module routes in the application’s IEndpointRouteBuilder.

Namespace: DevExpress.ExpressApp.Dashboards.Blazor

Assembly: DevExpress.ExpressApp.Dashboards.Blazor.v24.1.dll

NuGet Package: DevExpress.ExpressApp.Dashboards.Blazor

Declaration

C#

public static void MapXafDashboards(
    this IEndpointRouteBuilder endpoints,
    string dashboardEndpoint = "api/dashboard",
    string dashboardControllerName = "XafBlazorDashboard"
)

VB.NET

<ExtensionAttribute>
Public Shared Sub MapXafDashboards(
    endpoints As IEndpointRouteBuilder,
    dashboardEndpoint As String = "api/dashboard",
    dashboardControllerName As String = "XafBlazorDashboard"
)

Parameters

Name	Type	Description
endpoints	IEndpointRouteBuilder	The application’s route builder.

Optional Parameters

Name	Type	Default	Description
dashboardEndpoint	String	"api/dashboard"	The endpoint URL prefix used to send data requests to a server.
dashboardControllerName	String	"XafBlazorDashboard"	The Controller name without the Controller suffix.

Remarks

Call this method in the Startup.Configure method when you add the Dashboards Module to your ASP.NET Core Blazor application:

File: MySolution.Blazor.Server\Startup.cs.

C#

using DevExpress.ExpressApp.Dashboards.Blazor;
// ...
public class Startup {
    // ...
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env) {
        // ...
        app.UseEndpoints(endpoints => {
            endpoints.MapXafDashboards();
            // ...
        }
    }
    // ...
}