LegendStyle.BackgroundColor Property

Gets or sets the legend background color.

Namespace: DevExpress.XamarinForms.Charts

Assembly: DevExpress.XamarinForms.Charts.dll

NuGet Package: DevExpress.XamarinForms.Charts

Declaration

public Color BackgroundColor { get; set; }

Property Value

Type	Description
Color	A Color object that specifies the legend background color.

Remarks

To specify the legend border (color and thickness), use the BorderColor and BorderThickness properties.

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 x:Name="chartView">
    <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,150,10,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>

C#

using Xamarin.Forms;
using DevExpress.XamarinForms.Charts;
// ...

chartView.Legend = new Legend()
{
    Orientation = LegendOrientation.LeftToRight,
    VerticalPosition = LegendVerticalPosition.TopOutside,
    HorizontalPosition = LegendHorizontalPosition.Center,
    Style = new LegendStyle() {
        BorderColor = Color.LightGray,
        BorderThickness = 3,
        BackgroundColor = Color.Gray,
        MarkerSize = 30,
        TextIndent = 10,
        ItemsHorizontalIndent = 50,
        Padding = new Padding(150, 150, 10, 10),
        TextStyle = new TextStyle() {
            Color = Color.White,
            Size = 24
        }
    }
};