ChartControl.CalcHitInfo(Int32, Int32) Method

Returns information on the chart elements located at the point with the specified x and y coordinates.

Namespace: DevExpress.XtraCharts

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

NuGet Package: DevExpress.Win.Charts

Declaration

C#

public ChartHitInfo CalcHitInfo(
    int x,
    int y
)

VB.NET

Public Function CalcHitInfo(
    x As Integer,
    y As Integer
) As ChartHitInfo

Parameters

Name	Type	Description
x	Int32	An integer value which specifies the x-coordinate of the test point relative to the chart’s top-left corner.
y	Int32	An integer value which specifies the y-coordinate of the test point relative to the chart’s top-left corner.

Returns

Type	Description
ChartHitInfo	A ChartHitInfo object which contains information about the chart elements located at the test point.

Remarks

Use the CalcHitInfo method to determine which element is located at the point with the specified x and y coordinates. For instance, this can be used when handling the chart’s Click event to determine which element was clicked. In such cases, pass the current mouse pointer’s coordinates as the method’s parameter.

Important

To enable hit testing at runtime so that this example works correctly, make sure that the ChartControl.RuntimeHitTesting property is set to true.

This method is supported for 2D Chart Types only. So, hit testing for 3D Chart Types isn’t supported in the current version of XtraCharts.

Example

This example demonstrates how to handle the ChartControl.MouseMove event, to determine which series point is located under the test point and display information about its argument and value using ToolTipController.

To enable hit testing at runtime so that this example works correctly, make sure that the ChartControl.RuntimeHitTesting property is set to true.

Form1.cs

using System;
using System.Windows.Forms;
using DevExpress.Utils;
using DevExpress.XtraCharts;
// ...
        private void Form1_Load(object sender, EventArgs e) {
            chartControl1.CrosshairEnabled = DefaultBoolean.False;
            chartControl1.RuntimeHitTesting = true;
        }


        private void chartControl1_MouseMove(object sender, MouseEventArgs e) {
            // Obtain hit information under the test point.
            ChartHitInfo hi = chartControl1.CalcHitInfo(e.X, e.Y);

            // Obtain the series point under the test point.
            SeriesPoint point = hi.SeriesPoint;

            // Check whether the series point was clicked or not.
            if (point != null) {
                // Obtain the series point argument.
                string argument = "Argument: " + point.Argument.ToString();

                // Obtain series point values.
                string values = "Value(s): " + point.Values[0].ToString();
                if (point.Values.Length > 1) {
                    for (int i = 1; i < point.Values.Length; i++) {
                        values = values + ", " + point.Values[i].ToString();
                    }
                }

                // Show the tooltip.
                toolTipController1.ShowHint(argument + "\n" + values, "SeriesPoint Data");
            }
            else {
                // Hide the tooltip.
                toolTipController1.HideHint();
            }
        }

Form1.vb

Imports System
Imports System.Windows.Forms
Imports DevExpress.Utils
Imports DevExpress.XtraCharts
' ...
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            chartControl1.CrosshairEnabled = DefaultBoolean.False
            chartControl1.RuntimeHitTesting = True
        End Sub


        Private Sub chartControl1_MouseMove(ByVal sender As Object, ByVal e As MouseEventArgs) Handles chartControl1.MouseMove
            ' Obtain hit information under the test point.
            Dim hi As ChartHitInfo = chartControl1.CalcHitInfo(e.X, e.Y)

            ' Obtain the series point under the test point.
            Dim point As SeriesPoint = hi.SeriesPoint

            ' Check whether the series point was clicked or not.
            If point IsNot Nothing Then
                ' Obtain the series point argument.
                Dim argument As String = "Argument: " & point.Argument.ToString()

                ' Obtain series point values.
                Dim values As String = "Value(s): " & point.Values(0).ToString()
                If point.Values.Length > 1 Then
                    For i As Integer = 1 To point.Values.Length - 1
                        values = values & ", " & point.Values(i).ToString()
                    Next i
                End If

                ' Show the tooltip.
                toolTipController1.ShowHint(argument & ControlChars.Lf & values, "SeriesPoint Data")
            Else
                ' Hide the tooltip.
                toolTipController1.HideHint()
            End If
        End Sub