IDataPointFilter.FilterDataPoint(DataPoint, Series, Int32) Method

Reference

Definition

Namespace:: System.Web.UI.DataVisualization.Charting

Assembly:: System.Web.DataVisualization.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Determines whether a particular data point in the series will be filtered.

public:
 bool FilterDataPoint(System::Web::UI::DataVisualization::Charting::DataPoint ^ point, System::Web::UI::DataVisualization::Charting::Series ^ series, int pointIndex);

public bool FilterDataPoint (System.Web.UI.DataVisualization.Charting.DataPoint point, System.Web.UI.DataVisualization.Charting.Series series, int pointIndex);

abstract member FilterDataPoint : System.Web.UI.DataVisualization.Charting.DataPoint * System.Web.UI.DataVisualization.Charting.Series * int -> bool

Public Function FilterDataPoint (point As DataPoint, series As Series, pointIndex As Integer) As Boolean

Parameters

point: DataPoint

The DataPoint object to be filtered.

series: Series

The Series object that the data point belongs to.

pointIndex: Int32

The index of the data point, which determines its position in the series.

Returns

Boolean

true if the data point is removed; otherwise, false.

Remarks

This method should be called for each data point in a series, and returns a Boolean value indicating whether a data point should be filtered.

To provide custom filtering, derive a new or existing class from the IDataPointFilter interface and then implement this method. Provide custom criteria matching logic, then return true or false to mark the data points to be filtered. After this method has been implemented, use one of the Filter method definitions in the DataManipulator class that takes an IDataPointFilter object as a parameter to perform the filtering.

Filtered points, by default, are removed from a series. They can also be displayed as empty points by setting the value of the FilterSetEmptyPoints property to true.

Filtered points can also be marked as filtered if they do not match filtering criteria, as determined by the FilterMatchedPoints value.

Applies to