Data Filtering

• Jun 07, 2019
• 4 minutes to read

This document describes how to filter chart data at the chart control level (as opposed to the filtering at the data source level).

Note

When dealing with large data sources, filtering data at the chart control level may not be as efficient as filtering at the data source level. If End-Users should not change filtering and sorting parameters, we recommend filtering and sorting your data source at the data level before it is visualized.

You can use the FilterControl or DevExpress.Xpf.Core.FilteringBehavior filter criteria builders to filter chart data or a chart’s series data. Refer to the Criteria Language Syntax guide to learn more about filter criteria.

In this guide, the Filtering Behavior is used to demonstrate how to filter chart’s data.

Below is an example of a Window containing a Chart Control and a Data Layout Control as the Filtering Behavior’s client. To filter a template-generated series, use the following XAML code:

Use the Series.FilterCriteria property to filter series or chart data source using the Criteria Language.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-filter-charts-data-source-using-filter-criteria-syntax-language-t568127.

MainWindow.xaml.vb

    Public Sub New()
        InitializeComponent()

        Dim dataStreamInfo As StreamResourceInfo = Application.GetResourceStream(New Uri("Data/GDPStatistic.xml", UriKind.RelativeOrAbsolute))
        Dim valueProvider As New XmlGdpValueProvider(dataStreamInfo.Stream)
        DataContext = New MainViewModel(valueProvider)
    End Sub
Public Class MainViewModel
    Private privateGdpValues As IEnumerable(Of GdpValue)
    Public Property GdpValues() As IEnumerable(Of GdpValue)
        Get
            Return privateGdpValues
        End Get
        Private Set(ByVal value As IEnumerable(Of GdpValue))
            privateGdpValues = value
        End Set
    End Property

    'Filter parameters
    Private privateMinGdpValue As Double
    Public Property MinGdpValue() As Double
        Get
            Return privateMinGdpValue
        End Get
        Private Set(ByVal value As Double)
            privateMinGdpValue = value
        End Set
    End Property
    Private privateMaxGdpValue As Double
    Public Property MaxGdpValue() As Double
        Get
            Return privateMaxGdpValue
        End Get
        Private Set(ByVal value As Double)
            privateMaxGdpValue = value
        End Set
    End Property
    Private privateStartYear As Integer
    Public Property StartYear() As Integer
        Get
            Return privateStartYear
        End Get
        Private Set(ByVal value As Integer)
            privateStartYear = value
        End Set
    End Property
    Private privateEndYear As Integer
    Public Property EndYear() As Integer
        Get
            Return privateEndYear
        End Get
        Private Set(ByVal value As Integer)
            privateEndYear = value
        End Set
    End Property
    Private privateCountryNames As IEnumerable(Of String)
    Public Property CountryNames() As IEnumerable(Of String)
        Get
            Return privateCountryNames
        End Get
        Private Set(ByVal value As IEnumerable(Of String))
            privateCountryNames = value
        End Set
    End Property
    Private privateContinentNames As IEnumerable(Of String)
    Public Property ContinentNames() As IEnumerable(Of String)
        Get
            Return privateContinentNames
        End Get
        Private Set(ByVal value As IEnumerable(Of String))
            privateContinentNames = value
        End Set
    End Property


    Public Sub New(ByVal valueProvider As XmlGdpValueProvider)
        GdpValues = valueProvider.GetValues()
        MinGdpValue = GdpValues.Min(Function(gdp) gdp.Value)
        MaxGdpValue = GdpValues.Max(Function(gdp) gdp.Value)
        StartYear = GdpValues.Min(Function(gdp) gdp.Year)
        EndYear = GdpValues.Max(Function(gdp) gdp.Year)
        CountryNames = GdpValues.Select(Function(gdp) gdp.CountryName)
        ContinentNames = GdpValues.Select(Function(gdp) gdp.ContinentName)

    End Sub
End Class
Public Class GdpValue
    <FilterLookup(DataSourceMember := "ContinentNames", UseBlanks := False)> _
    Public Property ContinentName() As String

    <FilterLookup(DataSourceMember := "CountryNames", UseBlanks := False)> _
    Public Property CountryName() As String

    <FilterRange(MaximumMember := "MaxGdpValue", MinimumMember := "MinGdpValue")> _
    Public Property Value() As Double

    <FilterRange(MinimumMember := "StartYear", MaximumMember := "EndYear")> _
    Public Property Year() As Integer
End Class

MainWindow.xaml

<dxmvvm:Interaction.Behaviors>
    <dx:FilteringBehavior x:Name="filteringBehavior" SourceType="{x:Type local:GdpValue}"/>
</dxmvvm:Interaction.Behaviors>
<Grid>
    <Grid.ColumnDefinitions>
        <ColumnDefinition Width="3*"/>
        <ColumnDefinition Width="*"/>
    </Grid.ColumnDefinitions>
    <dxc:ChartControl Grid.Column="0" DataSource="{Binding GdpValues}">
        <dxc:ChartControl.Legends>
            <dxc:Legend HorizontalPosition="Left" VerticalPosition="Top"/>
        </dxc:ChartControl.Legends>
        <dxc:XYDiagram2D SeriesDataMember="CountryName" >
            <dxc:XYDiagram2D.SeriesTemplate>
                <dxc:LineSeries2D ArgumentDataMember="Year" ValueDataMember="Value"
                                  FilterCriteria="{Binding ElementName=filteringBehavior, Path=FilterCriteria}">
                    <dxc:LineSeries2D.MarkerModel>
                        <dxc:SimpleMarker2DModel/>
                    </dxc:LineSeries2D.MarkerModel>
                </dxc:LineSeries2D>
            </dxc:XYDiagram2D.SeriesTemplate>
        </dxc:XYDiagram2D>
    </dxc:ChartControl>
    <dxlc:DataLayoutControl Grid.Column="1" CurrentItem="{Binding ElementName=filteringBehavior, Path=FilteringViewModel}"/>

MainWindow.xaml.cs

    public MainWindow() {
        InitializeComponent();

        StreamResourceInfo dataStreamInfo = Application.GetResourceStream(new Uri("Data/GDPStatistic.xml", UriKind.RelativeOrAbsolute));
        XmlGdpValueProvider valueProvider = new XmlGdpValueProvider(dataStreamInfo.Stream);
        DataContext = new MainViewModel(valueProvider);
    }
public class MainViewModel {
    public IEnumerable<GdpValue> GdpValues { get; private set; }

    //Filter parameters
    public double MinGdpValue { get; private set; }
    public double MaxGdpValue { get; private set; }
    public int StartYear { get; private set; }
    public int EndYear { get; private set; }
    public IEnumerable<string> CountryNames { get; private set; }
    public IEnumerable<string> ContinentNames { get; private set; }


    public MainViewModel(XmlGdpValueProvider valueProvider) {
        GdpValues = valueProvider.GetValues();
        MinGdpValue = GdpValues.Min(gdp => gdp.Value);
        MaxGdpValue = GdpValues.Max(gdp => gdp.Value);
        StartYear = GdpValues.Min(gdp => gdp.Year);
        EndYear = GdpValues.Max(gdp => gdp.Year);
        CountryNames = GdpValues.Select(gdp => gdp.CountryName);
        ContinentNames = GdpValues.Select(gdp => gdp.ContinentName);

    }
}
public class GdpValue {
    [FilterLookup(DataSourceMember = "ContinentNames", UseBlanks = false)]
    public string ContinentName { get; set; }

    [FilterLookup(DataSourceMember = "CountryNames", UseBlanks = false)]
    public string CountryName { get; set; }

    [FilterRange(MaximumMember = "MaxGdpValue", MinimumMember = "MinGdpValue")]
    public double Value { get; set; }

    [FilterRange(MinimumMember = "StartYear", MaximumMember = "EndYear")]
    public int Year { get; set; }
}