DashboardService Class

Obsolete. Provides a server side API for the ASPxDashboardDesigner control and MVC Designer.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.dll

Declaration

[Obsolete("The DashboardService class is obsolete now. Use DashboardConfigurator instead.")]
public sealed class DashboardService
<Obsolete("The DashboardService class is obsolete now. Use DashboardConfigurator instead.")>
Public NotInheritable Class DashboardService

Remarks

To prepare the ASPxDashboardDesigner/MVCxDashboardDesigner for the first use, you need to create the dashboard and data sources storages.

  1. Use the static DashboardService.SetDashboardStorage method to create a storage that will contain dashboards. You can use predefined dashboard storages (DashboardFileStorage or DashboardInMemoryStorage) or you can implement the IDashboardStorage interface to provide your own logic for managing dashboards using the Web Designer.
    Note

    The DashboardService uses the DashboardInMemoryStorage if you do not create the dashboard storage.

  2. Prepare data sources that are used to supply dashboards with data. You can do this in two ways.

    • Add connections string to the application configuration file. These strings are used in the Web Designer's UI to create new data sources.
    • Use the static DashboardService.SetDataSourceStorage method to create a storage that contains data sources available for end-users. You can use a predefined implementation of the in-memory storage (DataSourceInMemoryStorage) or you can implement the IDataSourceStorage interface to provide a custom data source storage.

The DashboardService class also exposes the DashboardService.DataApi property that allows you to access an API used supply the dashboard with data at runtime (for instance, using the DataApiProvider.ConfigureDataConnection or DataApiProvider.DataLoading events).

Inheritance

Object
DashboardService
See Also