DashboardBackendOptions Class

Contains options that allow you to configure the Web Dashboard’s back-end.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v21.1.Web.WebForms.dll

Declaration

public class DashboardBackendOptions

Remarks

Separated client and server parts require you to configure an ASP.NET Core or ASP.NET MVC Dashboard control as a server and create the client Web Dashboard application.

You can use a Web Dashboard in the following ways:

  • Create cross-platform Web Dashboard applications.
  • Integrate a Dashboard into anything that supports HTTP requests (e.g., websites, web applications). For example, see the GitHub Pages Demo.
  • Publish the Web Dashboard as a part of applications based on Angular, Knockout, Vue and similar frameworks.
  • Use the Dashboard with DevExtreme client-side widgets to create responsive web apps.

The table below shows the available compatibility options between the server and the supported client platforms. The column headers indicate what you can use on the server and the row headers show available clients.

Client \ Server

ASP.NET Core Controller

ASP.NET MVC Controller

ASP.NET HTTP Handlers

ASP.NET Web Forms Callback

Dashboard Component for Blazor

Supported

Not supported

Not supported

Not supported

Dashboard Component for Angular

Supported

Supported

Not supported

Not supported

Dashboard Component for React

Supported

Supported

Not supported

Not supported

Dashboard Component for Vue

Supported

Supported

Not supported

Not supported

Dashboard Control for JavaScript Applications (JQuery, Knockout, etc.)

Supported

Supported

Not supported

Not supported

ASP.NET Core Razor Extension

Supported

Supported

Not supported

Not supported

ASP.NET MVC Razor Extension

Supported

Supported

Not supported

Not supported

ASP.NET Web Forms (ASPxDashboard‘s API)[1]

Not supported

Not supported

Not supported

Supported

ASP.NET Web Forms (DashboardConfigurator‘s API)[2]

Not supported

Not supported

Supported

Not supported

Use the following properties/methods for a corresponding platform to configure server settings for the client application:

Platform

Member

ASP.NET Web Forms

ASPxDashboard.BackendOptions

ASP.NET MVC

DashboardExtensionSettings.BackendOptions

ASP.NET Core

DashboardBuilder.BackendOptions

HTML JS

DashboardControlOptions.endpoint / AjaxRemoteServiceOptions.headers

The code samples below show how to configure the client: 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");

For a WebForms control that uses the DashboardConfigurator‘s instance API, provide the Dashboard HTTP handler’s url instead of the controller’s address:

DashboardControl.BackendOptions.Uri = "{baseURL}/api/dashboard/DXDD.axd";

You need to set up cross-origin resource sharing (CORS) on your back-end to configure corresponding permissions to access selected resources from a server at a different origin.

Inheritance

Object
DashboardBackendOptions
Footnotes
  1. The default ASPxDashboard mode. The control uses the ASPxDashboard‘s API for server-side configuration and sends requests only to its instance.

  2. The control uses the DashboardConfigurator‘s API. The DashboardConfigurator uses HTTP Handlers to send requests to the server.

See Also