Master Filtering

The Dashboard allows you to use any data aware dashboard item as a filter for other dashboard items (Master Filter). End-users can select elements in a Master Filter item (grid records, chart bars, pie segments, etc.) to filter data in other dashboard items by the selected values.

MainFeatures_MasterFiltering_Win

Note

To learn how to apply filtering in a specific dashboard item, refer to the Interactivity section for this item.

Master Filtering Overview

Dashboard items can be divided into four groups by their master filtering capabilities.

  1. Data visualization dashboard items allow you to enable master filtering by specifying the selection mode. The following dashboard items allow you to manage their master filtering mode.

    To learn how to manage master filtering for these items, see Master Filter Settings.

  2. Filter elements represent a special type of dashboard item whose main purpose is to apply filtering to other dashboard items. This capability is always enabled for these dashboard items.

    The following filter elements are available.

    • Combo Box
    • List Box
    • Tree View

    Instead of switching between standard master filtering modes, some filter elements allow you to switch their type. This allows end-users to select a single value or multiple values.

    To learn more, see the Filter Elements section.

  3. Range Filter is a special type of dashboard item that displays a chart with selection thumbs and allows you to filter out values displayed along the argument axis.

    To learn more, see the Range Filter section.

  4. Dashboard item group allows you to manage interaction between dashboard items in and out of the group.

    To learn more about the interactivity capabilities of the dashboard item group, see the Interactivity paragraph in the Dashboard Item Group topic.

Master Filter Settings

Master Filter Modes

The Master Filter item supports two selection modes.

  • Multiple - Allows you to select multiple elements in the Master Filter item.
  • Single - Allows you to select only one element in the Master Filter item. When this mode is enabled, the default selection will be set to a Master Filter element. You can change this selection, but cannot clear it.

To enable/disable master filtering, use the Multiple Master Filter or Single Master Filter buttons in the Data Ribbon tab.

DataShaping_Interactivity_MultipleMasterFilter_Ribbon

In code, use the DashboardItemInteractivityOptions.MasterFilterMode property.

Note

If the selected dashboard item contains several types of elements that can be used for filtering, the Ribbon or Toolbar will provide the appropriate buttons to switch between these types (e.g., the Arguments, Series and Points buttons in the Chart). For details, refer to the documentation for individual dashboard items in the Designing Dashboard Items section.

Filtering Across Data Sources

When different items in a dashboard are bound to different data sources, you can specify that a particular Master Filter should be applied across data sources. This means that it will apply filtering to fields with matching names in all data sources.

Fields are matched by their full names. For fields in other data sources to be affected by Master Filtering, their names must match the name of the field in the current data source, and they must belong to the same hierarchy level so that their full names also match. For instance, Customer.City and Customer.Address.City will not be treated as matching fields.

To enable filtering across data sources, use the Cross-Data-Source Filtering button in the Data Ribbon tab.

DataShaping_Interactivity_MasterFilter_CrossDataSource_Ribbon

To do this in code, use the DataDashboardItem.IsMasterFilterCrossDataSource property.

Note

Make sure that the matching field is visible in the filter item. It is impossible to filter data by adding this field to hidden dimensions.

Preventing Items from Being Filtered

You can prevent specific dashboard items from being affected by Master Filters. To do this, use the Ignore Master Filters button in the Data Ribbon tab.

DataShaping_Interactivity_MasterFilter_Ignore_Ribbon

To do this in code, use the FilterableDashboardItemInteractivityOptions.IgnoreMasterFilters property.

If an item is placed in a container (for example, the Dashboard Item Group or Tab Page), container's settings affect the master filter scope. If the Ignore Master Filters option is set for the item within a group or tab page, the item ignores master filters from items in the same container but it uses master filters from items outside the container, including items from other groups or tab pages.

Apply Filtering

The DashboardDesigner.CanSetMasterFilter method allows you to determine whether master filtering can be applied to the specified dashboard item. Use the DashboardDesigner.GetAvailableFilterValues method (or the DashboardDesigner.GetEntireRange method for the Range Filter dashboard item) to obtain the values of all elements that can be selected in the master filter item's current state.

To apply filtering in code, use the DashboardDesigner.SetMasterFilter method (or the DashboardDesigner.SetRange method for the Range Filter dashboard item).

After filtering is applied or the state of the master filter item is changed, the DashboardDesigner.MasterFilterSet event is raised. Its MasterFilterSetEventArgs.SelectedValues and MasterFilterSetEventArgs.SelectedRange properties allow you to obtain the currently selected values or the selected range for the dashboard item that causes the event.

MasterFiltering_API

For instance, for the dashboard in the image above, the MasterFilterSetEventArgs.SelectedValues property returns "Andrew Fuller", "Ann Dodsworth" and "Laura Callahan" for the Grid dashboard item. For the Range Filter dashboard item, the MasterFilterSetEventArgs.SelectedRange property returns minimum and maximum values in the selected range ("March, 1997" and "October, 1997", respectively).

To clear the selection in the Master Filter item, use the DashboardDesigner.ClearMasterFilter method.

After the selection is cleared, the DashboardDesigner.MasterFilterCleared event is raised.

Neutral Filter Mode

The Neutral Filter Mode for filter elements does not apply any criteria to the data source when the filter element is initialized and displayed. This results in improved performance and usability.

To switch to a new mode, use Dashboard API. For more information, refer to the Neutral Filter Mode topic.

Examples

How to: Apply Master Filtering in DashboardViewer

How to: Apply Master Filtering in ASPxDashboardViewer

How to: Apply Master Filtering in MVCxDashboardViewer

How to: Apply Master Filtering in Code in OLAP Mode

How to: Apply Master Filtering in ASPxDashboardViewer in OLAP Mode