CustomLegendItem Class

An individual custom legend item.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

NuGet Packages: DevExpress.Charts, DevExpress.WindowsDesktop.Charts

Declaration

C#

public class CustomLegendItem :
    ChartElementNamed,
    ILegendItemData,
    ILegendItem,
    IDisposable

VB.NET

Public Class CustomLegendItem
    Inherits ChartElementNamed
    Implements ILegendItemData,
               ILegendItem,
               IDisposable

Related API Members

The following members return CustomLegendItem objects:

• ChartHitInfo.CustomLegendItem
• CustomLegendItemCollection.Item[Int32]
• CustomLegendItemCollection.Item[String]

Remarks

Use the Text property to specify the custom item’s text. To change the item marker appearance, use MarkerColor or MarkerImage properties. The CustomLegendItem.TextVisible and CustomLegendItem.MarkerVisible properties allow you control the item elements’ visibility.

The Legend.CustomItems property provides access to the CustomLegendItemCollection collection that stores custom items. A particular CustomLegendItem object can be accessed within the collection either using indexer notation or by its name (see the CustomLegendItemCollection.Item property).

Example

This example demonstrates how to add a custom item to the legend.

• Create a CustomLegendItem object and add it to the Legend.CustomItems collection.
• Use the MarkerImage and Text properties to specify the custom item’s content.
• The Legend.ItemVisibilityMode property allows you to define whether to show custom items and auto-generated items together.

The following code adds a custom legend item with an image and text.

C#

private void Form1_Load(object sender, EventArgs e) {
    double total = CalculateTotal(chartControl.Series[0]);

    CustomLegendItem customLegendItem = new CustomLegendItem();
    customLegendItem.MarkerImage.Image = new Bitmap("..\\..\\Images\\sum-icon.png");
    customLegendItem.MarkerImageSizeMode = ChartImageSizeMode.Zoom;
    customLegendItem.Text = string.Format("Total: ${0}M", total);            
    chartControl.Legend.CustomItems.Add(customLegendItem);
    chartControl.Legend.ItemVisibilityMode = LegendItemVisibilityMode.AutoGeneratedAndCustom;
    chartControl.Legend.Direction = LegendDirection.TopToBottom;
}
public Double CalculateTotal (Series series) {
    double total = 0;
    foreach(SeriesPoint point in series.Points) {
        total += point.Values[0];
    }
    return total;
}

VB.NET

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    Dim total As Double = CalculateTotal(chartControl.Series(0))
    Dim customLegendItem As CustomLegendItem = New CustomLegendItem
    customLegendItem.MarkerImage.Image = New Bitmap("..\..\Images\sum-icon.png")
    customLegendItem.MarkerImageSizeMode = ChartImageSizeMode.Zoom
    customLegendItem.Text = String.Format("Total: ${0}M", total)
    chartControl.Legend.CustomItems.Add(customLegendItem)
    chartControl.Legend.ItemVisibilityMode = LegendItemVisibilityMode.AutoGeneratedAndCustom
    chartControl.Legend.Direction = LegendDirection.TopToBottom
End Sub

Public Function CalculateTotal(ByVal series As Series) As Double
    Dim total As Double = 0
    For Each point As SeriesPoint In series.Points
        total = (total + point.Values(0))
    Next
    Return total
End Function

Inheritance

Object

ChartElement

ChartElementNamed

CustomLegendItem