Legend

• Dec 27, 2018
• 3 minutes to read

Legend is a chart element that displays series and series points’ designations:

Note that a legend’s content depends on a chart that displays a legend:

• The legend displays items that refer to series when the DXChart shows a legend. A legend item’s text contains DXSeriesBase.displayName in this case.

• The legend displays items for series points if the DXPieChart shows a legend. The DXSeriesBase.legendTextPattern property configures the legend items’ text.

How to: Change a legend’s position and layout

You can place a legend all around the chart area; for example, at the top-center, either horizontally or vertically. The image below shows a legend placed at the top-center with a horizontal layout.

See this code to learn how to obtain the image:

Objective C

DXLegend *legend = [[DXLegend alloc] init];
legend.horizontalPosition = DXLegendHorizontalPositionCenter;
legend.verticalPosition = DXLegendVerticalPositionTopOutside;
legend.orientation = DXLegendOrientationLeftToRight;
self.chart.legend = legend;

Swift

let legend = DXLegend()
legend.horizontalPosition = DXLegendHorizontalPosition.center
legend.verticalPosition = DXLegendVerticalPosition.topOutside
legend.orientation = DXLegendOrientation.leftToRight
self.chart.legend = legend

C#

this.chart.Legend = new DXLegend {
    HorizontalPosition = DXLegendHorizontalPosition.center,
    VerticalPosition = DXLegendVerticalPosition.topOutside,
    Orientation = DXLegendOrientation.LeftToRight
};

Use the following symbols to configure a legend’s layout and position.

DXChartBase.legend	Gets or sets a chart’s legend settings.
DXLegend	The chart legend options storage.
DXLegend.horizontalPosition	Gets or sets a legend’s horizontal position.
DXLegend.verticalPosition	Gets or sets a legend’s vertical position.
DXLegend.orientation	Gets or sets a legend’s layout orientation.

How to: Show or hide a series in a legend

Use the DXSeriesBase.showInLegend property, to show or hide an individual series in a legend:

Objective C

series.showInLegend = NO;

Swift

series.showInLegend = false

C#

series.ShowInLegend = false;

How to: Configure a legend’s appearance

You can style a legend like any other chart element. Below are changeable appearance parameters:

See the code snippet below to learn how to change this legend’s style:

Objective C

// All sizes are in screen points.
DXLegendStyle *style = [[DXLegendStyle alloc] init];
DXTextStyle *textStyle = [[DXTextStyle alloc] init];

style.borderColor = [UIColor colorWithWhite:0.4 alpha:1];
style.borderThickness = 5;
style.backgroundColor = [UIColor colorWithWhite:0.1647 alpha:1];
style.markerSize = 30;
style.textIndent = 25;
style.itemsHorizontalIndent = 25;
style.textStyle = textStyle;

textStyle.fontSize = 30;
textStyle.foregroundColor = [UIColor colorWithWhite:0.5 alpha:1];

legend.style = style;

Swift

// All sizes are in screen points.
let legendStyle = DXLegendStyle()
let legendTextStyle = DXTextStyle()

legendStyle.borderColor = UIColor(white:0.4, alpha:1)
legendStyle.borderThickness = 5
legendStyle.backgroundColor = UIColor(white:0.1647, alpha:1)
legendStyle.markerSize = 30
legendStyle.textIndent = 25
legendStyle.itemsVerticalIndent = 25
legendStyle.textStyle = legendTextStyle

legendTextStyle.fontSize = 30
legendTextStyle.foregroundColor = UIColor(white:0.5, alpha:1)

legend.style = legendStyle

C#

// All sizes are in screen points.
legend.Style = new DXLegendStyle {
    BorderColor = UIColor.FromWhiteAlpha(0.4, 1),
    BackgroundColor = UIColor.FromWhiteAlpha(0.1647, 1),
    BorderThickness = 5,
    MarkerSize = 30,
    TextIndent = 25,
    ItemsVerticalIndent = 25,
    TextStyle = new DXTextStyle {
        FontSize = 30,
        ForegroundColor = UIColor.FromWhiteAlpha(0.5, 1)
    }
};

The following symbols allow you to customize the legend’s appearance:

DXLegend.style	Gets or sets a legend’s style options.
DXLegendStyle	The legend’s appearance settings storage.