DataLabelBase Interface

Contains basic data label options and serves as the base for the DataLabelOptions interface.

Namespace: DevExpress.Spreadsheet.Charts

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

public interface DataLabelBase :
    ShapeFormat,
    ShapeFormatBase,
    ShapeTextFormat

VB.NET

Public Interface DataLabelBase
    Inherits ShapeFormat,
             ShapeFormatBase,
             ShapeTextFormat

Remarks

The DataLabelBase interface defines common options related to chart data labels. For example, it allows you to display data labels on a chart and specify what information should appear in each label: the data point value (DataLabelBase.ShowValue), the series name (DataLabelBase.ShowSeriesName), the category name (DataLabelBase.ShowCategoryName), the bubble size (DataLabelBase.ShowBubbleSize), the percentage value (DataLabelBase.ShowPercent), or the legend key (DataLabelBase.ShowLegendKey). When the data label contains multiple items, use the DataLabelBase.Separator property to specify a character to separate these items. To position data labels on a chart, utilize the DataLabelBase.LabelPosition property. To apply number format to data labels, use the DataLabelBase.NumberFormat property.

Example

The example below demonstrates how to create a pie chart and adjust the display settings of its data labels. In particular, set the DataLabelBase.ShowCategoryName and DataLabelBase.ShowPercent properties to true to display the category name and percentage value in a data label at the same time. To separate these items, assign a new line character to the DataLabelBase.Separator property, so the percentage value will be automatically wrapped to a new line.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheet-chart-api-e5222

DataLabelsActions.vb

Dim worksheet As Worksheet = workbook.Worksheets("chartTask1")
workbook.Worksheets.ActiveWorksheet = worksheet

' Create a chart and specify its location.
Dim chart As Chart = worksheet.Charts.Add(ChartType.Pie, worksheet("B2:C7"))
chart.TopLeftCell = worksheet.Cells("E2")
chart.BottomRightCell = worksheet.Cells("K15")

' Display the category name and percentage.
Dim dataLabels As DataLabelOptions = chart.Views(0).DataLabels
dataLabels.ShowCategoryName = True
dataLabels.ShowPercent = True
dataLabels.Separator = Constants.vbLf

' Set the chart style.
chart.Style = ChartStyle.ColorGradient
' Hide the legend.
chart.Legend.Visible = False
' Set the angle of the first pie-chart slice.
chart.Views(0).FirstSliceAngle = 100

DataLabelsActions.cs

Worksheet worksheet = workbook.Worksheets["chartTask1"];
workbook.Worksheets.ActiveWorksheet = worksheet;

// Create a chart and specify its location.
Chart chart = worksheet.Charts.Add(ChartType.Pie, worksheet["B2:C7"]);
chart.TopLeftCell = worksheet.Cells["E2"];
chart.BottomRightCell = worksheet.Cells["K15"];

// Display the category name and percentage.
DataLabelOptions dataLabels = chart.Views[0].DataLabels;
dataLabels.ShowCategoryName = true;
dataLabels.ShowPercent = true;
dataLabels.Separator = "\n";

// Set the chart style.
chart.Style = ChartStyle.ColorGradient;
// Hide the legend.
chart.Legend.Visible = false;
// Set the angle of the first pie-chart slice.
chart.Views[0].FirstSliceAngle = 100;