Manage Dashboard State

• Jun 19, 2019
• 3 minutes to read

A dashboard state describes the changes resulting from end-user interaction. The dashboard state is the DashboardState class instance and can contain the following objects:

Dashboard State Object	API
Selected master filter values for dashboard items.	DashboardItemState.MasterFilterValues
Current drill-down levels for dashboard items.	DashboardItemState.DrillDownValues
Selected Range Filter interval.	DashboardItemState.RangeFilterState
Selected dashboard item layers for the following items: Card Choropleth Map Gauges Pie Treemap	DashboardItemState.SelectedLayerIndex
A selected tab page.	DashboardItemState.TabPageName
Dashboard parameter values.	DashboardState.Parameters

Use the DashboardState.Items property to get access to the dashboard item state collection.

The DashboardViewer provides the following API to manage the dashboard state:

Member	Description
DashboardViewer.GetDashboardState	Gets the current dashboard state.
DashboardViewer.SetDashboardState	Applies the dashboard state to the loaded dashboard.
DashboardViewer.SetInitialDashboardState	Allows you to specify the initial dashboard state when loading a dashboard.

Example

Note

The complete sample project How to Save and Restore the Dashboard State is available in the DevExpress Examples repository.

The following code snippet shows how to create a dashboard state for in code:

C#

public DashboardState CreateDashboardState()
{
    DashboardState state = new DashboardState();
    // Set a range for a Range Filter.
    state.Items.Add(new DashboardItemState("rangeFilterDashboardItem1")
    {
        RangeFilterState = new RangeFilterState(
            new RangeFilterSelection(
                new DateTime(2015, 1, 1), new DateTime(2017, 1, 1)))
    });
    // Specify master filter and drill-down values.
    state.Items.Add(new DashboardItemState("gridDashboardItem1")
    {
        MasterFilterValues = new List<object[]>() { 
            new object[] { "Gravad lax" }, 
            new object[] { "Ikura" } },
        DrillDownValues = new List<object>() { "Seafood" }
    });
    // Set a dashboard item layer.
    state.Items.Add(new DashboardItemState("treemapDashboardItem1")
    {
        SelectedLayerIndex = 1
    });
    // Specify a default tab page.
    state.Items.Add(new DashboardItemState("tabContainerDashboardItem1")
    {
        TabPageName = "dashboardTabPage2"
    });
    // Define a dashboard parameter value.
    state.Parameters.Add(new DashboardParameterState()
    {
        Name = "ParameterCountry",
        Value = "UK",
        Type = typeof(string)
    });
    return state;
}

VB.NET

Public Function CreateDashboardState() As DashboardState
    Dim state As New DashboardState()
    ' Set a range for a Range Filter.
    state.Items.Add(New DashboardItemState("rangeFilterDashboardItem1") With {
                    .RangeFilterState = New RangeFilterState(
                    New RangeFilterSelection(New Date(2015, 1, 1), New Date(2017, 1, 1))
                    )})
    ' Specify master filter and drill-down values.
    state.Items.Add(New DashboardItemState("gridDashboardItem1") With {
        .MasterFilterValues = New List(Of Object())() From {
            New Object() { "Gravad lax" },
            New Object() { "Ikura" }
        },
        .DrillDownValues = New List(Of Object)() From {"Seafood"}
    })
    ' Set a dashboard item layer.
    state.Items.Add(New DashboardItemState("treemapDashboardItem1") With {.SelectedLayerIndex = 1})
    ' Specify a default tab page.
    state.Items.Add(New DashboardItemState("tabContainerDashboardItem1") With {.TabPageName = "dashboardTabPage2"})
    ' Define a dashboard parameter value.
    state.Parameters.Add(New DashboardParameterState() With {.Name = "ParameterCountry", .Value = "UK", .Type = GetType(String)})
    Return state
End Function