DashboardOlapDataSource Class

An OLAP data source that provides data for the dashboard.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v21.2.Core.dll

Declaration

C#

public class DashboardOlapDataSource :
    IDisposable,
    IDashboardDataSource,
    IDashboardComponent,
    IComponent,
    ISupportInitialize,
    ISupportPrefix,
    IDashboardDataSourceInternal,
    IDataComponent,
    IDataConnectionParametersService,
    ISensitiveInfoContainer

VB.NET

Public Class DashboardOlapDataSource
    Implements IDisposable,
               IDashboardDataSource,
               IDashboardComponent,
               IComponent,
               ISupportInitialize,
               ISupportPrefix,
               IDashboardDataSourceInternal,
               IDataComponent,
               IDataConnectionParametersService,
               ISensitiveInfoContainer

Remarks

To create a data source that uses a connection to an OLAP cube, create the instance of the DashboardOlapDataSource class and perform the following steps.

1. Create the OlapConnectionParameters class object and specify the DashboardOlapDataSource.ConnectionString property.

   Pass the resulting OlapConnectionParameters object to the DashboardOlapDataSource constructor.

   Note

   As an alternative, you can add a connection string with required parameters to the application configuration file. Then, assign the connection string name to the DashboardOlapDataSource.ConnectionName property.

2. Add the created DashboardOlapDataSource object to the Dashboard.DataSources collection.

For .NET Core Dashboard, OLAP mode supports the following data providers:

• XML for Analysis (XMLA) with MSMDPUMP;
• ADOMD.NET (from v 21.1.4).

Use the DashboardOlapDataSource.OlapDataProvider static property to specify the data provider.

Example

The following example demonstrates how to bind a dashboard to an OLAP cube using DashboardOlapDataSource.

The DashboardOlapDataSource allows you to establish a connection to the OLAP cube by specifying a connection string.

View Example

Form1.vb

Dim olapParams As New OlapConnectionParameters()
olapParams.ConnectionString = "provider=MSOLAP;" _
                    & ControlChars.CrLf & _
                    "data source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;" _
                    & ControlChars.CrLf & _
                    "initial catalog=Adventure Works DW Standard Edition;" _
                    & ControlChars.CrLf & _
                    "cube name=Adventure Works;"

Dim olapDataSource As New DashboardOlapDataSource(olapParams)
olapDataSource.Fill()

dashboardDesigner1.Dashboard.DataSources.Add(olapDataSource)

Form1.cs

OlapConnectionParameters olapParams = new OlapConnectionParameters();
olapParams.ConnectionString = @"provider=MSOLAP;
                      data source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;
                      initial catalog=Adventure Works DW Standard Edition;
                      cube name=Adventure Works;";

DashboardOlapDataSource olapDataSource = new DashboardOlapDataSource(olapParams);
olapDataSource.Fill();

dashboardDesigner1.Dashboard.DataSources.Add(olapDataSource);

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardOlapDataSource class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-designer-merge-dashboards-to-tabs/CS/DashboardMerger/DataSourceMerger.cs#L79

DashboardOlapDataSource olapDataSource = dataSourceToCopy as DashboardOlapDataSource;
if(olapDataSource != null) {

WebFormsDashboardConfigurator/CS/WebFormsDashboardConfigurator/Global.asax.cs#L23

// Registers an OLAP data source.
DashboardOlapDataSource olapDataSource = new DashboardOlapDataSource("OLAP Data Source", "olapConnection");
DashboardOlapDataSource.OlapDataProvider = OlapDataProviderType.Xmla;

how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-e5148/CS/Dashboard_OlapFiltering/Form1.cs#L13

PivotDashboardItem pivot1 = (PivotDashboardItem)dashboard.Items[0];
DashboardOlapDataSource olapDataSource = (DashboardOlapDataSource)dashboard.DataSources[0];

how-to-bind-a-dashboard-to-an-olap-cube-using-dashboardolapdatasource-t216477/CS/Dashboard_DashboardDataProviders/Form1.cs#L17

DashboardOlapDataSource olapDataSource = new DashboardOlapDataSource(olapParams);
olapDataSource.Fill();

how-to-bind-a-scatter-chart-dashboard-item-to-data-in-code-t306222/CS/Dashboard_CreateScatterChart/Form1.cs#L15

// stored in the app.config file.
DashboardOlapDataSource olapDataSource = new DashboardOlapDataSource();
olapDataSource.ConnectionName = "AdventureWorksString";

VB.NET

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DashboardMerger/DataSourceMerger.vb#L84

Dim olapDataSource As DashboardOlapDataSource = TryCast(dataSourceToCopy, DashboardOlapDataSource)
If olapDataSource IsNot Nothing Then

WebFormsDashboardConfigurator/VB/WebFormsDashboardConfigurator/Global.asax.vb#L25

' Registers an OLAP data source.
Dim olapDataSource As New DashboardOlapDataSource("OLAP Data Source", "olapConnection")
DashboardOlapDataSource.OlapDataProvider = OlapDataProviderType.Xmla

how-to-apply-filtering-to-a-dashboard-items-data-in-olap-mode-e5148/VB/Dashboard_OlapFiltering/Form1.vb#L15

Dim pivot1 As PivotDashboardItem = CType(dashboard.Items(0), PivotDashboardItem)
Dim olapDataSource As DashboardOlapDataSource = DirectCast(dashboard.DataSources(0), DashboardOlapDataSource)

how-to-bind-a-dashboard-to-an-olap-cube-using-dashboardolapdatasource-t216477/VB/Dashboard_DashboardDataProviders/Form1.vb#L19

Dim olapDataSource As New DashboardOlapDataSource(olapParams)
olapDataSource.Fill()

how-to-bind-a-scatter-chart-dashboard-item-to-data-in-code-t306222/VB/Dashboard_CreateScatterChart/Form1.vb#L17

' stored in the app.config file.
Dim olapDataSource As New DashboardOlapDataSource()
olapDataSource.ConnectionName = "AdventureWorksString"

Implements

IDashboardDataSource

IDataComponent

Inheritance

Object

DashboardOlapDataSource