Legend.CustomEntries Property

Provides access to a collection of modified legend entries.

Namespace: DevExpress.Spreadsheet.Charts

Assembly: DevExpress.Spreadsheet.v18.2.Core.dll

Declaration

C#

LegendEntryCollection CustomEntries { get; }

VB.NET

ReadOnly Property CustomEntries As LegendEntryCollection

Property Value

Type	Description
LegendEntryCollection	A LegendEntryCollection object that contains modified legend entries.

Remarks

When a legend is displayed (Legend.Visible property is true), you can modify the individual legend entries by adding items to the LegendEntryCollection and setting their properties.

The example below demonstrates how to remove the required entries from the chart legend by utilizing the Legend.CustomEntries property.

Note

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

LegendActions.vb

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

' Create a chart and specify its location.
Dim chart As Chart = worksheet.Charts.Add(ChartType.ColumnClustered, worksheet("B2:F6"))
chart.TopLeftCell = worksheet.Cells("H2")
chart.BottomRightCell = worksheet.Cells("N14")

' Exclude entries from the legend.
chart.Legend.CustomEntries.Add(2).Hidden = True
chart.Legend.CustomEntries.Add(3).Hidden = True

LegendActions.cs

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

// Create a chart and specify its location.
Chart chart = worksheet.Charts.Add(ChartType.ColumnClustered, worksheet["B2:F6"]);
chart.TopLeftCell = worksheet.Cells["H2"];
chart.BottomRightCell = worksheet.Cells["N14"];

// Exclude entries from the legend.
chart.Legend.CustomEntries.Add(2).Hidden = true;
chart.Legend.CustomEntries.Add(3).Hidden = true;