HeatmapAxis.CustomLabels Property

Returns the collection of custom axis labels.

Namespace: DevExpress.XtraCharts.Heatmap

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Elements)]
[XtraSerializableProperty(XtraSerializationVisibility.Collection, true)]
public CustomAxisLabelCollection CustomLabels { get; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Elements)>
<XtraSerializableProperty(XtraSerializationVisibility.Collection, True)>
Public ReadOnly Property CustomLabels As CustomAxisLabelCollection

Property Value

Type	Description
CustomAxisLabelCollection	The custom label collection.

Remarks

You can display custom labels with default labels or in place of default labels. The adapter creates default labels based on cell arguments. Use the CustomLabels property to access an axis’s custom label collection. The following example displays a custom label on an x-axis:

C#

heatmap.AxisX.CustomLabels.Add(new CustomAxisLabel { 
    AxisValue = "West", 
    Name = "Division: West", 
    BackColor = Color.LightGray });
heatmap.AxisX.LabelVisibilityMode = AxisLabelVisibilityMode.AutoGeneratedAndCustom;

VB.NET

heatmap.AxisX.CustomLabels.Add(New CustomAxisLabel With {
    .AxisValue = "West",
    .Name = "Division: West",
    .BackColor = Color.LightGray
})
heatmap.AxisX.LabelVisibilityMode = AxisLabelVisibilityMode.AutoGeneratedAndCustom