Dundas Chart for ASP.NET
Filter(CompareMethod,Double,Series) Method
See Also  Example Send comments on this topic.
Dundas.Charting.WebControl Namespace > DataManipulator Class > Filter Method : Filter(CompareMethod,Double,Series) Method


compareMethod
A CompareMethod enumeration value that determines the comparison method for the filtering rule. Can be "less than", "equal to", etc. .
Value comparing method.
compareValue
The value of the filtering rule that the first Y-values of data points are compared to.
Value to compare with.
inputSeries
Series object that is filtered. It is also used to store the modified data.
Input series.

Enterprise Edition Only Feature. Filters a series' data points by applying a filtering rule to the first Y-value of data points. The Series object that is filtered is used to store the modified data.


Filters points by point's values.

Syntax

Visual Basic (Declaration)  
Public Overloads Sub Filter( _
   ByVal compareMethod As CompareMethod, _
   ByVal compareValue As Double, _
   ByVal inputSeries As Series _
) 
Visual Basic (Usage) Copy Code
Dim instance As DataManipulator
Dim compareMethod As CompareMethod
Dim compareValue As Double
Dim inputSeries As Series
 
instance.Filter(compareMethod, compareValue, inputSeries)
C#  
public void Filter( 
   CompareMethod compareMethod,
   double compareValue,
   Series inputSeries
)

Parameters

compareMethod
A CompareMethod enumeration value that determines the comparison method for the filtering rule. Can be "less than", "equal to", etc. .
Value comparing method.
compareValue
The value of the filtering rule that the first Y-values of data points are compared to.
Value to compare with.
inputSeries
Series object that is filtered. It is also used to store the modified data.
Input series.

Example

The following sample filters out all data points in "Series1" that have a first Y-value that is greater than 20.
Visual Basic Copy Code
Imports Dundas.Charting.WebControl<CRLF>...<CRLF><CRLF>' Apply filtering rule of ">20"<CRLF>Chart1.DataManipulator.Filter(CompareMethod.More, 20.0, Chart1.Series("Series1"))
C# Copy Code
using Dundas.Charting.WebControl;<CRLF>  ...<CRLF><CRLF>// Apply filtering rule of "&gt;20"<CRLF>Chart1.DataManipulator.Filter(Microsoft.VisualBasic.CompareMethod.More, 20.0, Chart1.Series["Series1"]);

Remarks

This method filters data points by applying a filtering rule, which is composed of an operator and a value (e.g. "< 5", "= 2.7", etc.). Data points are filtered using the first Y-value of the points, and by default if they match this filtering rule they are deleted from the 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).

Filters are always applied to an entire series.

To filter data and preserve the original series use another definition of this function that uses an output series parameter.

To filter other values of data points (e.g. the second Y-value, etc.) use one of the function definitions that has a usingValue parameter.

To filter data and only keep a specified number of highest or lowest values use the FilterTopN method instead.

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

Copyright © 2001 - 2009 Dundas Data Visualization, Inc. and others.