Skip to main content

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.v22.1.Core.dll

Declaration

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

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.

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')";

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.

See Also