CustomLegendItem Class

An individual custom legend item.

Namespace: DevExpress.Xpf.Charts

Assembly: DevExpress.Xpf.Charts.v19.2.dll

Declaration

public class CustomLegendItem :
    ChartNotificationElement,
    ILegendVisible
Public Class CustomLegendItem
    Inherits ChartNotificationElement
    Implements ILegendVisible

Returned By

The ChartHitInfoBase.CustomLegendItem property returns an instance of CustomLegendItem.

Remarks

The CustomLegendItem class contains the settings that define the functionality of a custom item within a legend.

In addition to the settings inherited from the base ChartElement class, the CustomLegendItem class implements properties that allow you to specify the text used to display an item (the CustomLegendItem.Text property), brush (CustomLegendItem.MarkerBrush) and data template (CustomLegendItem.MarkerTemplate) used to display an item's marker and control the item elements visibility (Visibility).

Custom items associated with a particular legend are contained within the Legend.CustomItems collection which is represented by an object of the CustomLegendItemCollection class. A particular CustomLegendItem object can be accessed in the collection using either indexer notation.

Examples

To add a custom legend item to a legend, create a new instance of the CustomLegendItem class and add it to the Legend.CustomItems collection. Then, configure the custom item, for example, using the CustomLegendItem.Text property to set the item's text and the CustomLegendItem.MarkerTemplate property to set the item's marker.

<Window.Resources>
    <DataTemplate x:Key="markerTemplate">
        <Image Source="Images/DXLogo.png"/>
    </DataTemplate>
</Window.Resources>
        <dxc:ChartControl.Legend>
            <dxc:Legend ItemVisibilityMode="AutoGeneratedAndCustom">
                <dxc:Legend.CustomItems>
                    <dxc:CustomLegendItem MarkerBrush="#FFFF8000" 
                                          MarkerTemplate="{Binding Source={StaticResource markerTemplate}}" 
                                          Text="Powered by DevExpress"/>
                </dxc:Legend.CustomItems>
            </dxc:Legend>
        </dxc:ChartControl.Legend>

Implements

Inheritance

See Also