AxisLabelItemBase.AxisValue Property

Provides access to the axis value to which an axis label item corresponds.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Misc)]
public object AxisValue { get; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Misc)>
Public ReadOnly Property AxisValue As Object

Property Value

Type	Description
Object	An object that specifies the axis value.

Remarks

An axis label item is the specific instance of the AxisLabelItem class, obtained in the ChartControl.CustomDrawAxisLabel (or WebChartControl.CustomDrawAxisLabel) event handler.

The axis value obtained using the AxisValue property is determined in the measure units appropriate for the scale type of the axis. To obtain an internal floating representation of this value, use the AxisLabelItemBase.AxisValueInternal property.

For more information, refer to Axis Labels.

Example

Apart from the capability to customize the overall appearance of axis labels, you can obtain individual axis labels at runtime. Then, it’s possible to apply all the options available for axis labels to them, individually. For example, based on some criteria (e.g. an axis value threshold), you can apply different formatting to axis labels.

For this, the special ChartControl.CustomDrawAxisLabel event is introduced. Handle it to obtain axis labels.

Note

For the WebChartControl you should handle its WebChartControl.CustomDrawSeries event to implement this task.

The following code demonstrates one possible implementation of this capability.

C#

private void chartControl1_CustomDrawAxisLabel(object sender, CustomDrawAxisLabelEventArgs e) {
    AxisBase axis = e.Item.Axis;
    if (axis is AxisY || axis is AxisY3D || axis is RadarAxisY) {
        double axisValue = (double)e.Item.AxisValue;
        if (axisValue < 0) {
            e.Item.TextColor = Color.Red;
        }
        else if (axisValue > 0) {
            e.Item.Text = "+" + e.Item.Text;
            e.Item.TextColor = Color.Green;
        }
        else if (axisValue == 0) {
            e.Item.Text = "Zero";
        }
    }
}

VB.NET

Private Sub chartControl1_CustomDrawAxisLabel(sender As Object, e As CustomDrawAxisLabelEventArgs)
   Dim axis As AxisBase = e.Item.Axis
   If TypeOf axis Is AxisY Or TypeOf axis Is AxisY3D Or TypeOf axis Is RadarAxisY Then
      Dim axisValue As Double = CDbl(e.Item.AxisValue)
      If axisValue < 0 Then
         e.Item.TextColor = Color.Red
      Else
         If axisValue > 0 Then
            e.Item.Text = "+" + e.Item.Text
            e.Item.TextColor = Color.Green
         Else
            If axisValue = 0 Then
               e.Item.Text = "Zero"
            End If
         End If
      End If
   End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AxisValue 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#

winforms-charts-how-to-individually-customize-axis-labels/CS/CustomAxisLabels/Form1.cs#L15

if (axis is AxisY || axis is AxisY3D || axis is RadarAxisY) {
    double axisValue = (double)e.Item.AxisValue;
    if (axisValue < 0)

VB.NET

winforms-charts-how-to-individually-customize-axis-labels/VB/CustomAxisLabels/Form1.vb#L18

If TypeOf axis Is AxisY OrElse TypeOf axis Is AxisY3D OrElse TypeOf axis Is RadarAxisY Then
    Dim axisValue As Double = CDbl(e.Item.AxisValue)
    If axisValue < 0 Then