-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
IDataPointFilter.xml
79 lines (67 loc) · 6.08 KB
/
IDataPointFilter.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<Type Name="IDataPointFilter" FullName="System.Web.UI.DataVisualization.Charting.IDataPointFilter">
<TypeSignature Language="C#" Value="public interface IDataPointFilter" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IDataPointFilter" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.DataVisualization.Charting.IDataPointFilter" />
<TypeSignature Language="VB.NET" Value="Public Interface IDataPointFilter" />
<TypeSignature Language="F#" Value="type IDataPointFilter = interface" />
<TypeSignature Language="C++ CLI" Value="public interface class IDataPointFilter" />
<AssemblyInfo>
<AssemblyName>System.Web.DataVisualization</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>Exposes the <see cref="M:System.Web.UI.DataVisualization.Charting.IDataPointFilter.FilterDataPoint(System.Web.UI.DataVisualization.Charting.DataPoint,System.Web.UI.DataVisualization.Charting.Series,System.Int32)" /> method, which allows <see cref="T:System.Web.UI.DataVisualization.Charting.Series" /> data to be custom filtered.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.DataVisualization.Charting.IDataPointFilter> interface exposes the <xref:System.Web.UI.DataVisualization.Charting.IDataPointFilter.FilterDataPoint%2A> method, which takes a specific data point within a series and returns a `Boolean` value that determines whether that data point will be filtered.
To perform custom filtering:
- Derive a new or existing class from this interface.
- Override the <xref:System.Web.UI.DataVisualization.Charting.IDataPointFilter.FilterDataPoint%2A> method to provide the custom filtering logic.
- To initiate the filtering operation, call one of the `Filter` methods in the <xref:System.Web.UI.DataVisualization.Charting.DataManipulator> class that takes an <xref:System.Web.UI.DataVisualization.Charting.IDataPointFilter> object as its first parameter.
For sample source code, see the <xref:System.Web.UI.DataVisualization.Charting.IDataPointFilter.FilterDataPoint%2A> method.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="FilterDataPoint">
<MemberSignature Language="C#" Value="public bool FilterDataPoint (System.Web.UI.DataVisualization.Charting.DataPoint point, System.Web.UI.DataVisualization.Charting.Series series, int pointIndex);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool FilterDataPoint(class System.Web.UI.DataVisualization.Charting.DataPoint point, class System.Web.UI.DataVisualization.Charting.Series series, int32 pointIndex) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.DataVisualization.Charting.IDataPointFilter.FilterDataPoint(System.Web.UI.DataVisualization.Charting.DataPoint,System.Web.UI.DataVisualization.Charting.Series,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Function FilterDataPoint (point As DataPoint, series As Series, pointIndex As Integer) As Boolean" />
<MemberSignature Language="F#" Value="abstract member FilterDataPoint : System.Web.UI.DataVisualization.Charting.DataPoint * System.Web.UI.DataVisualization.Charting.Series * int -> bool" Usage="iDataPointFilter.FilterDataPoint (point, series, pointIndex)" />
<MemberSignature Language="C++ CLI" Value="public:
 bool FilterDataPoint(System::Web::UI::DataVisualization::Charting::DataPoint ^ point, System::Web::UI::DataVisualization::Charting::Series ^ series, int pointIndex);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.DataVisualization</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="point" Type="System.Web.UI.DataVisualization.Charting.DataPoint" />
<Parameter Name="series" Type="System.Web.UI.DataVisualization.Charting.Series" />
<Parameter Name="pointIndex" Type="System.Int32" />
</Parameters>
<Docs>
<param name="point">The <see cref="T:System.Web.UI.DataVisualization.Charting.DataPoint" /> object to be filtered.</param>
<param name="series">The <see cref="T:System.Web.UI.DataVisualization.Charting.Series" /> object that the data point belongs to.</param>
<param name="pointIndex">The index of the data point, which determines its position in the series.</param>
<summary>Determines whether a particular data point in the series will be filtered.</summary>
<returns>
<see langword="true" /> if the data point is removed; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## 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 <xref:System.Web.UI.DataVisualization.Charting.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 <xref:System.Web.UI.DataVisualization.Charting.DataManipulator> class that takes an <xref:System.Web.UI.DataVisualization.Charting.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 <xref:System.Web.UI.DataVisualization.Charting.DataManipulator.FilterSetEmptyPoints%2A> property to `true`.
Filtered points can also be marked as filtered if they do not match filtering criteria, as determined by the <xref:System.Web.UI.DataVisualization.Charting.DataManipulator.FilterMatchedPoints%2A> value.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>