Skip to main content
All docs
V25.1
  • .NET 8.0+
    • The page you are viewing does not exist in the .NET Framework 4.6.2+ platform documentation. This link will take you to the parent topic of the current section.

    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.v25.1.dll

    NuGet Package: DevExpress.ExpressApp.Dashboards.Blazor

    Declaration

    public static void MapXafDashboards(
        this IEndpointRouteBuilder endpoints,
        string dashboardEndpoint = "api/dashboard",
        string dashboardControllerName = "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.

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