ChartHitInfo Class

Contains information about a specific point within a chart.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.2.dll

NuGet Packages: DevExpress.Charts, DevExpress.WindowsDesktop.Charts

Declaration

C#

[RuntimeObject]
public class ChartHitInfo

VB.NET

<RuntimeObject>
Public Class ChartHitInfo

Related API Members

The following members return ChartHitInfo objects:

Library	Related API Members
Cross-Platform Class Library	HotTrackEventArgs.HitInfo
WinForms Controls	ChartControl.CalcHitInfo(Int32, Int32)
	ChartControl.CalcHitInfo(Point, Boolean)

Remarks

ChartHitInfo objects can be created by calling the chart’s ChartControl.CalcHitInfo method. This method requires the test point as a parameter, or its coordinates.

The ChartHitInfo class properties can be grouped into three logical categories:

• The properties indicating whether the test point resides over a particular view element. For instance, the ChartHitInfo.InChartTitle property indicates whether the test point is over the chart title or not;
• The ChartHitInfo.HitTest property identifying the type of the topmost element located under the test point;
• The ChartHitInfo.HitObject and ChartHitInfo.HitObjects properties identifying the topmost element or the collection of all visual elements which contains the test point.

Example

The following examples demonstrates how to handle the ChartControl.MouseMove event and calculate the hit information for the point which the mouse pointer is currently hovering over. Then, the name of the chart element located under the mouse pointer is shown within the form caption.

C#

using System.Windows.Forms;
using DevExpress.XtraCharts;
// ...

private void chartControl1_MouseMove(object sender, MouseEventArgs e) {
    ChartHitInfo hi = chartControl1.CalcHitInfo(new System.Drawing.Point(e.X, e.Y));
    this.Text = hi.HitTest.ToString();
}

VB.NET

Imports System.Windows.Forms
Imports DevExpress.XtraCharts
' ...

Private Sub ChartControl1_MouseMove(ByVal sender As System.Object, ByVal e As MouseEventArgs) _
Handles ChartControl1.MouseMove
    Dim hi As ChartHitInfo = ChartControl1.CalcHitInfo(New System.Drawing.Point(e.X, e.Y))
    Me.Text = hi.HitTest.ToString()
End Sub

Inheritance

Object

ChartHitInfo