CrosshairLegendElement Class

Defines the crosshair legend element’s appearance when custom drawing a crosshair cursor using the ChartControl.CustomDrawCrosshair event.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

public class CrosshairLegendElement :
    CrosshairLegendElementBase

VB.NET

Public Class CrosshairLegendElement
    Inherits CrosshairLegendElementBase

Remarks

Use the CustomDrawCrosshairEventArgs.CrosshairLegendElements property to get access to the CrosshairLegendElement objects and customize their appearance.

Refer to Tooltip and Crosshair Cursor for more information.

Example

This example demonstrates how to modify the Crosshair Cursor’s appearance using the ChartControl.CustomDrawCrosshair event.

In this sample, crosshair content is displayed in a legend. For this, set the CrosshairOptions.ContentShowMode to the Legend value that the CrosshairContentShowMode enumeration contains. Note that you can specify the crosshair’s content show mode for the specified series using the SeriesBase.CrosshairContentShowMode property.

Use the CustomDrawCrosshairEventArgs.CrosshairLegendElements property to obtain the crosshair legend elements’ collection.

To customize crosshair legend element options, use the CrosshairLegendElement class properties:

• CrosshairLegendElementBase.AxisLabelElement - Returns the Crosshair Cursor‘s axis label element to change its settings when using the ChartControl.CustomDrawCrosshair event to modify the Crosshair’s appearance.
• CrosshairLegendElementBase.LineElement - Returns the crosshair line element settings.
• CrosshairLegendElementBase.Series - Returns the series which the Crosshair Cursor highlights.
• CrosshairLegendElement.SeriesPoint - Returns the series point which the Crosshair Cursor highlights.

Form1.cs

private void Form1_Load(object sender, System.EventArgs e) {
    chartControl.CrosshairOptions.ContentShowMode = CrosshairContentShowMode.Legend;
    chartControl.CrosshairOptions.ShowValueLabels = true;
    chartControl.CrosshairOptions.ShowValueLine = true;
}
private void OnCustomDrawCrosshair(object sender, CustomDrawCrosshairEventArgs e) {
    foreach(CrosshairLegendElement legendElement in e.CrosshairLegendElements) {
        legendElement.TextColor = (legendElement.SeriesPoint.Values[0] > ColorSelectorValue) ? Color.Green : Color.Red;
        legendElement.LineElement.Color = legendElement.TextColor;
        legendElement.AxisLabelElement.BackColor = legendElement.TextColor;
    }
}

Form1.vb

Private Sub Form1_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
    chartControl.CrosshairOptions.ContentShowMode = CrosshairContentShowMode.Legend
    chartControl.CrosshairOptions.ShowValueLabels = True
    chartControl.CrosshairOptions.ShowValueLine = True
End Sub
Private Sub OnCustomDrawCrosshair(ByVal sender As Object, ByVal e As CustomDrawCrosshairEventArgs) Handles chartControl.CustomDrawCrosshair
    For Each legendElement As CrosshairLegendElement In e.CrosshairLegendElements
        legendElement.TextColor = If(legendElement.SeriesPoint.Values(0) > ColorSelectorValue, Color.Green, Color.Red)
        legendElement.LineElement.Color = legendElement.TextColor
        legendElement.AxisLabelElement.BackColor = legendElement.TextColor
    Next legendElement
End Sub

Inheritance

Object

BaseCrosshairLabelElement

CrosshairLegendElementBase

CrosshairLegendElement