ChartControl.HitTest(Int32, Int32) Method

Returns specific chart elements, which are located under the test point.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.2.UI.dll

NuGet Package: DevExpress.Win.Charts

Declaration

C#

public object[] HitTest(
    int x,
    int y
)

VB.NET

Public Function HitTest(
    x As Integer,
    y As Integer
) As Object()

Parameters

Name	Type	Description
x	Int32	An integer value that specifies the x coordinate of the test point.
y	Int32	An integer value that specifies the y coordinate of the test point.

Returns

Type	Description
Object[]	An array of Objects, that represent the chart elements located under the test point.

Remarks

A SeriesPoint isn’t a chart element. To get the current series point under the test point, you need to use the ChartControl.CalcHitInfo method and use the ChartHitInfo.SeriesPoint property.

Note

The HitTest method is supported in 2D charts only. It can’t be used for 3D charts.

Example

The following example handles the ChartControl.MouseMove event to identify the chart element under the mouse pointer and display its name in the form’s caption.

Note

Turn on the ChartControl.RuntimeHitTesting option to enable hit testing.

C#

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

namespace DXApplication {
    public partial class Form1 : DevExpress.XtraEditors.XtraForm {
        public Form1() {
            InitializeComponent();
            chartControl1.MouseMove += ChartControl1_MouseMove;
            chartControl1.RuntimeHitTesting = true;
        }

        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 DevExpress.XtraCharts
Imports System.Windows.Forms

Namespace DXApplication
    Public Partial Class Form1
        Inherits DevExpress.XtraEditors.XtraForm

        Public Sub New()
            InitializeComponent()
            AddHandler chartControl1.MouseMove, AddressOf ChartControl1_MouseMove
            chartControl1.RuntimeHitTesting = True
        End Sub

        Private Sub ChartControl1_MouseMove(sender As Object, e As MouseEventArgs)
            Dim hi As ChartHitInfo = chartControl1.CalcHitInfo(New System.Drawing.Point(e.X, e.Y))
            Me.Text = hi.HitTest.ToString()
        End Sub
    End Class
End Namespace