How to: Apply Master Filtering in ASPxDashboardViewer in OLAP Mode

• Aug 03, 2020
• 2 minutes to read

Important

This documentation applies to v16.2. Starting with v17.1, the ASPxDashboardViewer control is in maintenance mode. In v19.1, the new Web Dashboard Control replaces the old Web Dashboard Viewer. This means that the Web Dashboard Viewer will not be included in our installation packages. See our blog post for more information.

Refer to the following KB articles to learn how to migrate to ASPxDashboard / ASP.NET MVC Dashboard:

• ASPxDashboardViewer -> ASPxDashboard

  How to migrate from ASPxDashboardViewer to ASPxDashboard working in the ViewerOnly mode

• MVCxDashboardViewer -> MVCxDashboard

  How to migrate from DashboardViewerExtension to DashboardExtension working in the ViewerOnly mode

The following example demonstrates how to apply master filtering in ASPxDashboardViewer on the client side when the dashboard is connected to an OLAP cube.

In this example, the ASPxClientDashboardViewer.SetMasterFilter method is used to select required cards in the Card dashboard item. This method is called in the ASPxClientButton.Click event handler of ASPxButton1.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-apply-master-filtering-in-aspxdashboardviewer-in-olap-mode-t140278.

WebForm1.aspx (VB.NET)

    <div>    
        <dx:ASPxButton ID="ASPxButton1" runat="server" Text="SetMasterFilter" 
            AutoPostBack="False">
            <ClientSideEvents Click="function(s, e) {
                onButtonClick(s, e);
}" />
        </dx:ASPxButton> 
    </div>
    <div>
        <dx:ASPxDashboardViewer ID="ASPxDashboardViewer1" runat="server" DashboardId="" FullscreenMode=true
            DashboardSource="~/App_Data/Dashboard.xml" 
            DashboardXmlFile="~/App_Data/Dashboard.xml"
            ClientInstanceName="WebViewer">
        </dx:ASPxDashboardViewer>        
    </div>
<script type="text/javascript" src="<%=Page.ResolveClientUrl("~/Scripts/MasterFilter.js")%>"></script>

MasterFilter.js (VB.NET)

function onButtonClick(s, e) {
    var cardValues1 = ['[Date].[Calendar Year].&[2001]', '[Date].[Calendar Quarter of Year].&[CY Q4]'];
    var cardValues2 = ['[Date].[Calendar Year].&[2002]', '[Date].[Calendar Quarter of Year].&[CY Q1]'];
    WebViewer.SetMasterFilter("cardDashboardItem1", [cardValues1, cardValues2]);
}

MasterFilter.js (C#)

function onButtonClick(s, e) {
    var cardValues1 = ['[Date].[Calendar Year].&[2001]', '[Date].[Calendar Quarter of Year].&[CY Q4]'];
    var cardValues2 = ['[Date].[Calendar Year].&[2002]', '[Date].[Calendar Quarter of Year].&[CY Q1]'];
    WebViewer.SetMasterFilter("cardDashboardItem1", [cardValues1, cardValues2]);
}

WebForm1.aspx (C#)

    <div>    
        <dx:ASPxButton ID="ASPxButton1" runat="server" Text="SetMasterFilter" 
            AutoPostBack="False">
            <ClientSideEvents Click="function(s, e) {
                onButtonClick(s, e);
}" />
        </dx:ASPxButton> 
    </div>
    <div>
        <dx:ASPxDashboardViewer ID="ASPxDashboardViewer1" runat="server" DashboardId="" FullscreenMode=true
            DashboardSource="~/App_Data/Dashboard.xml" 
            DashboardXmlFile="~/App_Data/Dashboard.xml"
            ClientInstanceName="WebViewer">
        </dx:ASPxDashboardViewer>        
    </div>
<script type="text/javascript" src="<%= Page.ResolveClientUrl("~/Scripts/MasterFilter.js")%>"></script>