Legend Class

Stores chart legend settings.

Namespace: DevExpress.XamarinForms.Charts

Assembly: DevExpress.XamarinForms.Charts.dll

Declaration

public class Legend :
    StyledElement

Related API Members

The following members return Legend objects:

• ChartBaseView.Legend

Remarks

Legend is an explanatory component that accompanies a chart diagram and identifies its most important visual elements: series, series points, constant lines and strips.

The Legend class properties define chart legend settings:

• Orientation - Specifies whether legend items are positioned vertically from the top to the bottom or horizontally from the left to the right.
• HorizontalPosition, VerticalPosition - Control the legend position within a chart.
• Style - Provides access to legend appearance settings.
• Visible - Allows you to show or hide a legend.

To configure a chart legend, assign a Legend object with the specified properties to the chart’s Legend property.

Example

This example shows how to add a legend to a pie chart and adjust the legend settings.

1. To add a legend to the chart, assign a Legend object to the PieChartView.Legend property and use the following properties of this object to specify the legend orientation and position:

   • Orientation - display legend items in a row, from left to right.
   • VerticalPosition - place the legend above the chart diagram.
   • HorizontalPosition - align the legend horizontally to the center.

2. Set the Legend.Style property to a LegendStyle object and specify the following properties of this object to configure the legend appearance:

   • BorderColor and BorderThickness - configure the legend border.
   • BackgroundColor - specify the background color.
   • MarkerSize and TextIndent - change the size of markers, and set the distance between an item text and marker.
   • ItemsHorizontalIndent - specify the distance between legend items.
   • Padding - specify the distance between legend edges and content.
   • TextStyle - change the item text color and size.

3. To exclude points of the chart’s first series from the legend, set the VisibleInLegend property of this series to false.

XAML

<dxc:PieChartView>
    <dxc:PieChartView.Series>
        <dxc:DonutSeries Data="{Binding SecuritiesByTypes}" VisibleInLegend="False"/>
        <dxc:DonutSeries Data="{Binding SecuritiesByRisk}"/>
    </dxc:PieChartView.Series>
    <dxc:PieChartView.Legend>
        <dxc:Legend Orientation="LeftToRight"
                    VerticalPosition="TopOutside"
                    HorizontalPosition="Center">
            <dxc:Legend.Style>
                <dxc:LegendStyle BorderColor="LightGray" BorderThickness="3"
                                 BackgroundColor="Gray"
                                 MarkerSize="30" TextIndent="10"
                                 ItemsHorizontalIndent="50"
                                 Padding="150,10,150,10">
                    <dxc:LegendStyle.TextStyle>
                        <dxc:TextStyle Color="White" Size="24"/>
                    </dxc:LegendStyle.TextStyle>
                </dxc:LegendStyle>
            </dxc:Legend.Style>
        </dxc:Legend>
    </dxc:PieChartView.Legend>
</dxc:PieChartView>

Implements

INotifyPropertyChanged

Inheritance

Object

Xamarin.Forms.BindableObject

ChartElement

StyledElement

Legend