Manage Dashboard State

• Dec 20, 2018

A dashboard state describes the changes resulting from end-user interaction. The dashboard state object is the DashboardState class instance. It may contain:

• Selected master filter values for dashboard items
• Current drill-down levels for dashboard items
• Selected Range Filter interval
• Selected dashboard item layers for the following items:
  • Card
  • Choropleth Map
  • Gauges
  • Pie
  • Treemap
• Dashboard parameter values.

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

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