SeriesBase.LabelsVisibility Property

Specifies whether to show labels for a series.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Appearance)]
[XtraSerializableProperty]
public DefaultBoolean LabelsVisibility { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Appearance)>
<XtraSerializableProperty>
Public Property LabelsVisibility As DefaultBoolean

Property Value

Type	Description
DefaultBoolean	True to show series labels; False to hide them; Default - label visibility depends on the series view and chart control type.

Available values:

Name	Description	Return Value
True	The value is true.	0
False	The value is false.	1
Default	The value is specified by a global option or a higher-level object.	2

Remarks

Series point labels are visible in the following cases:

• A series view type is pie, donut, 3D pie or 3D donut.
• A series view type is compatible with XY-Diagram 3D.
• A series is plotted within the XRChart control.

In all other cases, series labels are hidden until you enable them.

The following table shows the LabelsVisibility property in action.

LabelsVisibility = DefaultBoolean.False	LabelsVisibility = DefaultBoolean.True

Example

This example demonstrates how to customize the Side-by-Side Bar series label position and appearance.

Use the following API members to customize bar series labels:

Member	Description
Series.LabelsVisibility	Specifies whether to show series labels.
BarSeriesLabel	Defines label settings for bar series.
SeriesLabelBase.BackColor	Gets or sets the label’s background color.
SeriesLabelBase.Border	Gets the label’s border settings.
SeriesLabelBase.Font	Gets or sets the font used to display the label’s content.
BarSeriesLabel.Position	Specifies the position of series point labels, relative to their corresponding Bars.
SeriesLabelBase.TextOrientation	Specifies the direction of text within the series labels.
SeriesLabelBase.TextPattern	Gets or sets a string which represents the pattern specifying the text to be displayed within series labels.

C#

private void OnFormLoad(object sender, EventArgs e) {
    chartControl1.Series[0].LabelsVisibility = DevExpress.Utils.DefaultBoolean.True;

    BarSeriesLabel seriesLabel = chartControl1.Series[0].Label as BarSeriesLabel;
    seriesLabel.BackColor = Color.White;
    seriesLabel.Border.Color = Color.DarkSlateGray;
    seriesLabel.Font = new Font("Tahoma", 10, FontStyle.Regular);
    seriesLabel.Position = BarSeriesLabelPosition.TopInside;
    seriesLabel.TextOrientation = TextOrientation.Horizontal;
    seriesLabel.TextPattern = "{V:F1}";            
}

VB.NET

Private Sub OnFormLoad(ByVal sender As Object, ByVal e As EventArgs)
    chartControl1.Series(0).LabelsVisibility = DevExpress.Utils.DefaultBoolean.[True]

    Dim seriesLabel As BarSeriesLabel = TryCast(chartControl1.Series(0).Label, BarSeriesLabel)
    seriesLabel.BackColor = Color.White
    seriesLabel.Border.Color = Color.DarkSlateGray
    seriesLabel.Font = New Font("Tahoma", 10, FontStyle.Regular)
    seriesLabel.Position = BarSeriesLabelPosition.TopInside
    seriesLabel.TextOrientation = TextOrientation.Horizontal
    seriesLabel.TextPattern = "{V:F1}"
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LabelsVisibility 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-sort-stacked-bar-chart-bars-by-the-sum-of-the-corresponding-values-e967/CS/Form1.cs#L39

s1.LabelsVisibility = s2.LabelsVisibility = s3.LabelsVisibility = DevExpress.Utils.DefaultBoolean.False;

winforms-charts-apply-the-best-fit-function-to-a-series/CS/LineOfBestFit/Form1.cs#L77

BestFit.ArgumentScaleType = ScaleType.Numerical;
BestFit.LabelsVisibility = DevExpress.Utils.DefaultBoolean.False;
BestFit.Tag = tag;

how-to-change-the-series-line-color-when-the-value-is-under-a-predefined-level-e462/CS/Form1.cs#L31

chartControl1.Series.Add(series);
series.LabelsVisibility = DevExpress.Utils.DefaultBoolean.True;
series.Label.TextPattern = "{V:N2}";

xtracharts-how-to-create-a-model-for-a-custom-chart-element/CS/CustomChartElementModel/Form1.cs#L119

series.LabelsVisibility = DevExpress.Utils.DefaultBoolean.True;
series.Label.ResolveOverlappingMode = ResolveOverlappingMode.HideOverlapped;

winforms-charts-configure-settings-for-template-series-and-series-added-manually/CS/series-base-example/Form1.cs#L39

series.ValueScaleType= ScaleType.Numerical;
series.LabelsVisibility = DefaultBoolean.True;
series.Label.TextPattern = "{A}: {V:F2}";

VB.NET

how-to-sort-stacked-bar-chart-bars-by-the-sum-of-the-corresponding-values-e967/VB/Form1.vb#L37

s3.LabelsVisibility = DevExpress.Utils.DefaultBoolean.False
s2.LabelsVisibility = s3.LabelsVisibility

winforms-charts-apply-the-best-fit-function-to-a-series/VB/LineOfBestFit/Form1.vb#L85

BestFit.ArgumentScaleType = ScaleType.Numerical
BestFit.LabelsVisibility = DevExpress.Utils.DefaultBoolean.False
BestFit.Tag = tag

how-to-change-the-series-line-color-when-the-value-is-under-a-predefined-level-e462/VB/Form1.vb#L33

chartControl1.Series.Add(series)
series.LabelsVisibility = DevExpress.Utils.DefaultBoolean.True
series.Label.TextPattern = "{V:N2}"

xtracharts-how-to-create-a-model-for-a-custom-chart-element/VB/CustomChartElementModel/Form1.vb#L179

view.Colorizer = New CustomPointColorizer() With {.Value = 60, .LowerValuePointColor = Color.Red, .UpperValuePointColor = Color.Green}
series.LabelsVisibility = DevExpress.Utils.DefaultBoolean.True
series.Label.ResolveOverlappingMode = ResolveOverlappingMode.HideOverlapped

winforms-charts-configure-settings-for-template-series-and-series-added-manually/VB/series-base-example/Form1.vb#L39

series.ValueScaleType = ScaleType.Numerical
series.LabelsVisibility = DefaultBoolean.True
series.Label.TextPattern = "{A}: {V:F2}"