CustomLegendItem.MarkerImage Property

Returns the custom legend item’s marker image.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v21.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Data)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public ChartImage MarkerImage { get; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Data)>
<PersistenceMode(PersistenceMode.InnerProperty)>
Public ReadOnly Property MarkerImage As ChartImage

Property Value

Type	Description
ChartImage	A ChartImage object that defines the image used as a legend item marker.

Remarks

Use the Image property to load an image to the Chart Control. Use the ChartImage.ImageUrl property to define the URL of the image source for the WebChartControl.

Example

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

• Create a CustomLegendItem object and add it to the LegendBase.CustomItems collection.
• Use the MarkerImage and Text properties to specify the custom item’s content.
• The LegendBase.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