SeriesBase.Label Property

Gets series label settings.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v23.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Elements)]
public SeriesLabelBase Label { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Elements)>
Public Property Label As SeriesLabelBase

Property Value

Type	Description
SeriesLabelBase	A SeriesLabelBase object that provides the series label settings.

Remarks

The Label property provides access to the settings that specify the appearance, content, and position of series point labels.

Note that you cannot set the Label property. It is available to be set for serialization purposes only.

The label type depends on the series view. The following table lists series views and appropriate label types:

Show the table

Pattern	Description
3D Area	Area3DSeriesLabel
Bar	BarSeriesLabel
3D Bar	Bar3DSeriesLabel
Bubble	BubbleSeriesLabel
Doughnut	DoughnutSeriesLabel
3D Doughnut	Doughnut3DSeriesLabel
Full-Stacked Area	FullStackedAreaSeriesLabel
3D Full-Stacked Area	FullStackedArea3DSeriesLabel
Full-Stacked Bar	FullStackedBarSeriesLabel
3D Full-Stacked Bar	FullStackedBar3DSeriesLabel
Funnel	FunnelSeriesLabel
3D Funnel	Funnel3DSeriesLabel
3D Line	Line3DSeriesLabel
Nested Doughnut	NestedDoughnutSeriesLabel
Pie	PieSeriesLabel
3D Pie	Pie3DSeriesLabel
Radar, Polar	RadarPointSeriesLabel
Area, Step Area, Spline Area Point, Line, Step Line	PointSeriesLabel
Radar Range Area, Polar Range Area	RadarRangeAreaSeriesLabel
Range Area	RangeAreaSeriesLabel
3D Range Area	RangeArea3DSeriesLabel
Side-by-Side Range Bar, Overlapped Range Bar, Side-by-Side Gantt, Overlapped Gantt	RangeBarSeriesLabel
Side-by-Side Bar	SideBySideBarSeriesLabel
3D Stacked Area	StackedArea3DSeriesLabel
Stacked Bar	StackedBarSeriesLabel
3D Stacked Bar	StackedBar3DSeriesLabel
Stacked Line	StackedLineSeriesLabel
3D Stacked Line	StackedLine3DSeriesLabel
Stock, Candle Stick	StockSeriesLabel

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