DataDashboardItem.FilterString Property

Gets or sets the criteria string used to filter data displayed within the current dashboard item.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(null)]
public string FilterString { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property FilterString As String

Property Value

Type	Default	Description
String	null	A String that specifies the criteria string used to filter data displayed within the current dashboard item.

Remarks

Refer to the following help topic for more information about building filter criteria: Expression Constants, Operators, and Functions

Note

You cannot build complex criteria to filter data in OLAP mode.

Example

The following code shows how to apply filtering to a dashboard item in code. Note that the DataItem.UniqueId property is specified for Dimension objects to identify these dimensions in a filter string.

C#

ChartDashboardItem chart = new ChartDashboardItem();
Dimension issueTypeDimension = new Dimension("issueTypeID", "IssueType");
Dimension productNameDimension = new Dimension("productNameID", "ProductName");
Measure openedMeasure = new Measure("Opened", SummaryType.Count);

// ...

chart.FilterString = "issueTypeID = 'Critical' And productNameID In ('Web Forms', 'Mobile')";

VB.NET

Dim chart As New ChartDashboardItem()
Dim issueTypeDimension As New Dimension("issueTypeID", "IssueType")
Dim productNameDimension As New Dimension("productNameID", "ProductName")
Dim openedMeasure As New Measure("Opened", SummaryType.Count)

' ...

chart.FilterString = "issueTypeID = 'Critical' And productNameID In ('Web Forms', 'Mobile')"

Related GitHub Examples

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

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/ParametersMerger.cs#L38

foreach(DataDashboardItem item in dataDashboardItems) {
    if(!String.IsNullOrEmpty(item.FilterString) && item.FilterString.Contains(originalNamePattern)) {
        item.FilterString = item.FilterString.Replace(originalNamePattern, copyNamePattern);

winforms-dashboard-pass-dashboard-parameters-to-filter-string-in-code/CS/Dashboard_Parameters/Form1.cs#L35

// Include the created parameter in filter strings as an operand value.
grid.FilterString = "categoryColumn in (?categoryParameter)";
pie.FilterString = "categorySeries in (?categoryParameter)";

winforms-dashboard-filtering-in-olap-mode/CS/Dashboard_OlapFiltering/Form1.cs#L38

pivot1.FilterString = filterCriteria.ToString();
dashboardDesigner1.Dashboard = dashboard;

VB.NET

winforms-dashboard-designer-merge-dashboards-to-tabs/VB/DashboardMerger/ParametersMerger.vb#L43

For Each item As DataDashboardItem In dataDashboardItems
    If Not String.IsNullOrEmpty(item.FilterString) AndAlso item.FilterString.Contains(originalNamePattern) Then
        item.FilterString = item.FilterString.Replace(originalNamePattern, copyNamePattern)

winforms-dashboard-pass-dashboard-parameters-to-filter-string-in-code/VB/Dashboard_Parameters/Form1.vb#L35

' Include the created parameter in filter strings as an operand value.
grid.FilterString = "categoryColumn in (?categoryParameter)"
pie.FilterString = "categorySeries in (?categoryParameter)"

winforms-dashboard-filtering-in-olap-mode/VB/Dashboard_OlapFiltering/Form1.vb#L35

pivot1.FilterString = filterCriteria.ToString()
dashboardDesigner1.Dashboard = dashboard