Dundas Chart for Windows Forms
Filter(IDataPointFilter,Series,Series) Method
See Also  Example Send comments on this topic.
DundasWinChart Assembly > Dundas.Charting.WinControl Namespace > DataManipulator Class > Filter Method : Filter(IDataPointFilter,Series,Series) Method


filterInterface
An object that implements the IDataPointFilter interface.
Filtering interface.
inputSeries
Series object that is filtered.
Input series.
outputSeries
Series object that stores the filtered data. If the series does not exist an exception will be thrown.
Output series.

Enterprise Edition Only Feature. Performs custom filtering on a series' data points.


Filters data points using IDataPointFilter interface.

Syntax

Visual Basic (Declaration)  
Public Overloads Sub Filter( _
   ByVal filterInterface As IDataPointFilter, _
   ByVal inputSeries As Series, _
   ByVal outputSeries As Series _
)
Visual Basic (Usage) Copy Code
Dim instance As DataManipulator
Dim filterInterface As IDataPointFilter
Dim inputSeries As Series
Dim outputSeries As Series
 
instance.Filter(filterInterface, inputSeries, outputSeries)
C#  
public void Filter( 
   IDataPointFilter filterInterface,
   Series inputSeries,
   Series outputSeries
)

Parameters

filterInterface
An object that implements the IDataPointFilter interface.
Filtering interface.
inputSeries
Series object that is filtered.
Input series.
outputSeries
Series object that stores the filtered data. If the series does not exist an exception will be thrown.
Output series.

Example

The following sample filters Series1 data points if their second Y-value is greater than 100, and stores them in Series2.
Visual Basic Copy Code
Imports Dundas.Charting.WinControl
...

' Implement the IDataPointFilter interface for our web form
Public Class WebForm1
    Inherits System.Web.UI.Page
    Implements IDataPointFilter
    ...

    ' Declare function that contains the custom filtering logic (used by the Filter function)
    Public Function FilterDataPoint(ByVal point As DataPoint, ByVal series As Series, ByVal pointIndex As Integer) As Boolean _
        Implements IDataPointFilter.FilterDataPoint

        ' If Y2 (second Y value) is greater than 100 filter out this data point, otherwise keep it
        If point.YValues(1) > 100 Then
            FilterDataPoint = True
        Else
            FilterDataPoint = False
        End If

    End Function
    ...

    ' Perform filtering before data is displayed by chart
    Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
        Chart1.DataManipulator().Filter(Me, Chart1.Series("Series1"), Chart1.Series("Series2"))
    End Sub
    ...

Remarks

To utilize this method use a new or existing class (e.g. the WebForm class) that implements the IDataPointFilter interface and then override the FilterDataPoint method to provide custom filtering logic.

Note that filtering can be based on any attribute(s) of the data points (e.g. their first, second and third Y-values, etc.).

If the specified output series has not been created and added to the SeriesCollection when this function call is made an exception will be thrown.

Filters are always applied to an entire series.

Filtered points can be either removed from a series (default) or displayed as empty points, depending on the FilterSetEmptyPoints value.

Points can also be marked as filtered if they DO NOT match filtering criteria (determined by the FilterMatchPoints value).

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2009 All Rights Reserved.