The requested page is not available for the requested platform. You are viewing the content for Default platform.

DashboardBackendOptionsBuilder Class

Contains methods that allow you to configure the Web Dashboard's back-end.

Namespace: DevExpress.DashboardAspNetCore

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

Declaration

public class DashboardBackendOptionsBuilder
Public Class DashboardBackendOptionsBuilder

Remarks

You can use the Web Dashboard for more than a combined application. The Web Dashboard allows you to separate the client and server parts. This means you can:

  • Integrate a dashboard in any place that supports HTTP requests (e.g., see the GitHub Pages Demo).
  • Publish Web Dashboard as a part of applications based on Angular, Knockout, Vue and similar frameworks.
  • Use the Dashboard side-by-side with DevExtreme client-side widgets to create highly responsive web apps.

The table below illustrates correlations between server and client. The row headers display platforms you can use as a server, the column headers show available client counterparts.

Server \ Client

ASP.NET Web Forms

ASP.NET MVC

ASP.NET Core

HTML JS

ASP.NET Web Forms (UseDashboardConfigurator = false)

-

-

-

-

ASP.NET Web Forms (UseDashboardConfigurator = true)

OK

-

-

-

ASP.NET MVC

OK

OK

OK

OK

ASP.NET Core

OK

OK

OK

OK

Use the DashboardBuilder.BackendOptions method to configure a server from the client application:

Platform

Member

ASP.NET Web Forms

ASPxDashboard.BackendOptions

ASP.NET MVC

DashboardExtensionSettings.BackendOptions

ASP.NET Core

HTML JS

DashboardControlOptions.endpoint / AjaxRemoteServiceOptions.headers

The code samples below show how to configure the client: to set the server's url and pass a custom Authorization header. Note that the server's url should consist of a base URL where the Web Dashboard's server side is hosted and a route prefix - a value that is set in the MVC / .NET Core MapDashboardRoute properties.

For MVC or ASP.NET Core back-end, the url is a controller's address:

DashboardControl.BackendOptions.Uri = "{baseURL}/api/dashboard";
DashboardControl.BackendOptions.RequestHttpHeaders.Add("Authorization", "AuthToken123");

Inheritance

Object
DashboardBackendOptionsBuilder
See Also