Legend.CustomItems Property
Returns the custom legend item collection.
Namespace: DevExpress.XtraCharts
Assembly: DevExpress.XtraCharts.v18.2.dll
Declaration
[XtraChartsLocalizableCategory(XtraChartsCategory.Elements)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[XtraSerializableProperty(XtraSerializationVisibility.Collection, true)]
public CustomLegendItemCollection CustomItems { get; }
Property Value
Type | Description |
---|---|
CustomLegendItemCollection | A collection of CustomLegendItem objects. |
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.
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;
}
See Also