ChartHitInfo.InSeries Property

Gets a value indicating whether the test point is within the series.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.dll

Declaration

C#

public bool InSeries { get; }

VB.NET

Public ReadOnly Property InSeries As Boolean

Property Value

Type	Description
Boolean	true if the test point is within a series; otherwise, false.

Remarks

The InSeries property is useful if you don’t need to determine the exact element residing under the test point and are only interested in whether the point is within a series. For instance, the property can be used if you need to provide a common context menu for a series regardless of which particular series element was right-clicked. If you need to obtain a particular element located under the test point, use the ChartHitInfo.HitTest property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the InSeries property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-integrate-a-charting-module-example-solution-e4636/CS/InventoryChart_4/Form1.cs#L29

{
    if (e.HitInfo.InSeries && e.AdditionalObject is SeriesPoint)
    {

how-to-show-chart-legend-with-markers-in-separate-control-e2366/CS/Form1.cs#L61

{
    if (e.HitInfo.InSeries)
    {

how-to-determine-the-count-of-series-point-values-required-to-draw-series-t329058/CS/ArgumentCountDetectionSample/Form1.cs#L13

private void chartControl1_ObjectSelected(object sender, HotTrackEventArgs e) {
    if (e.HitInfo.InSeries) {
        int count = e.HitInfo.Series.View.ValuesCount;

how-to-draw-a-custom-legend-marker-for-a-series-t332672/CS/CustomDrawingSample/Form1.cs#L58

private void OnObjectHotTracked(object sender, HotTrackEventArgs e) {
    trackedSeriesName = e.HitInfo.InSeries ? ((Series)e.HitInfo.Series).Name : null;
}

how-to-enable-tooltip-support-for-chartcontrol-e2294/CS/CS/ChartControlToolTipHelper.cs#L50

ChartHitInfo hitInfo = Chart.CalcHitInfo(point);
if (!hitInfo.InSeries) return null;
return new ToolTipControlInfo(hitInfo.SeriesPoint, GetToolTipText(hitInfo.SeriesPoint),

VB.NET

how-to-integrate-a-charting-module-example-solution-e4636/VB/InventoryChart_4/Form1.vb#L26

Private Sub inventoryChart_ObjectSelected(ByVal sender As Object, ByVal e As DevExpress.XtraCharts.HotTrackEventArgs) Handles inventoryChart.ObjectSelected
    If e.HitInfo.InSeries AndAlso TypeOf e.AdditionalObject Is SeriesPoint Then
        Dim currentPoint As SeriesPoint = CType(e.AdditionalObject, SeriesPoint)

how-to-show-chart-legend-with-markers-in-separate-control-e2366/VB/Form1.vb#L63

Private Sub chart_ObjectSelected(ByVal sender As Object, ByVal e As HotTrackEventArgs) Handles chart.ObjectSelected
    If e.HitInfo.InSeries Then
        gridView1.FocusedRowHandle = gridView1.GetRowHandle(chart.Series.IndexOf((CType(e.Object, Series))))

how-to-determine-the-count-of-series-point-values-required-to-draw-series-t329058/VB/ArgumentCountDetectionSample/Form1.vb#L15

Private Sub chartControl1_ObjectSelected(ByVal sender As Object, ByVal e As HotTrackEventArgs) Handles chartControl1.ObjectSelected
    If e.HitInfo.InSeries Then
        Dim count As Integer = e.HitInfo.Series.View.ValuesCount

how-to-draw-a-custom-legend-marker-for-a-series-t332672/VB/CustomDrawingSample/Form1.vb#L56

Private Sub OnObjectHotTracked(ByVal sender As Object, ByVal e As HotTrackEventArgs)
    trackedSeriesName = If(e.HitInfo.InSeries, CType(e.HitInfo.Series, Series).Name, Nothing)
End Sub

how-to-enable-tooltip-support-for-chartcontrol-e2294/VB/CS/ChartControlToolTipHelper.vb#L85

Dim hitInfo As ChartHitInfo = Chart.CalcHitInfo(point)
If Not hitInfo.InSeries Then
    Return Nothing