wpf-devexpress-dot-xpf-dot-charts-dot-chartcontrol-6b6f5a0e.md
Gets the chart control’s legend and provides access to its settings.
Namespace : DevExpress.Xpf.Charts
Assembly : DevExpress.Xpf.Charts.v25.2.dll
NuGet Package : DevExpress.Wpf.Charts
public Legend Legend { get; set; }
Public Property Legend As Legend
| Type | Description |
|---|---|
| Legend |
A Legend object that represents the chart control’s legend.
|
For more information on the chart control’s legend, see the Legend object’s description.
Note
Using the ChartControlBase.Legends property instead of this property is recommended.
This example shows how to create a 2D Side-by-Side Bar chart.
Create a ChartControl and set its ChartControl.Diagram property to a XYDiagram2D object. Note that the ChartControl.Diagram is a content property. You can declare a diagram in XAML directly after a chart control’s declaration without wrapping it in opening and closing ChartControl.Diagram tags.
Specify the Diagram.SeriesItemsSource property to bind a collection of objects used to generate series.
Use the following API members to configure the x-axis options.
Create a legend and customize its settings. For more information about legends, refer to the following topic: Legends
View Example: Chart for WPF - Create a 2D Side-by-Side Bar Chart
<Window x:Class="SideBySideBar2DChart.Window1"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:dxc="http://schemas.devexpress.com/winfx/2008/xaml/charts"
xmlns:local="clr-namespace:SideBySideBar2DChart"
Title="Window1" Height="350" Width="620">
<Window.DataContext>
<local:ChartViewModel/>
</Window.DataContext>
<Grid>
<dxc:ChartControl Name="chartControl1">
<dxc:ChartControl.Diagram>
<dxc:XYDiagram2D SeriesItemsSource="{Binding Data}">
<dxc:XYDiagram2D.SeriesItemTemplate>
<DataTemplate>
<dxc:BarSideBySideSeries2D DisplayName="{Binding Name}"
DataSource="{Binding Values}"
ArgumentDataMember="Argument"
ValueDataMember="Value"
BarWidth="0.6">
<dxc:BarSideBySideSeries2D.Model>
<dxc:BorderlessSimpleBar2DModel/>
</dxc:BarSideBySideSeries2D.Model>
</dxc:BarSideBySideSeries2D>
</DataTemplate>
</dxc:XYDiagram2D.SeriesItemTemplate>
<dxc:XYDiagram2D.AxisX>
<dxc:AxisX2D>
<dxc:AxisX2D.DateTimeScaleOptions>
<dxc:ManualDateTimeScaleOptions MeasureUnit="Year" GridAlignment="Year"
AutoGrid="False" GridSpacing="1"/>
</dxc:AxisX2D.DateTimeScaleOptions>
</dxc:AxisX2D>
</dxc:XYDiagram2D.AxisX>
</dxc:XYDiagram2D>
</dxc:ChartControl.Diagram>
<dxc:ChartControl.Legends>
<dxc:Legend HorizontalPosition="Right"/>
</dxc:ChartControl.Legends>
</dxc:ChartControl>
</Grid>
</Window>
using System;
using System.Collections.ObjectModel;
using System.Windows;
namespace SideBySideBar2DChart {
public partial class Window1 : Window {
public Window1() {
InitializeComponent();
}
}
public class ChartViewModel {
public ObservableCollection<DataSeries> Data { get; private set; }
public ChartViewModel() {
Data = new ObservableCollection<DataSeries> {
new DataSeries{
Name = "DevAV North",
Values = new ObservableCollection<DataPoint> {
new DataPoint (new DateTime(2013,12,31), 362.5),
new DataPoint (new DateTime(2014,12,31), 348.4),
new DataPoint (new DateTime(2015,12,31), 279.0),
new DataPoint (new DateTime(2016,12,31), 230.9),
new DataPoint (new DateTime(2017,12,31), 203.5),
new DataPoint (new DateTime(2018,12,31), 197.1)
}
},
new DataSeries{
Name = "DevAV South",
Values = new ObservableCollection<DataPoint> {
new DataPoint (new DateTime(2013,12,31), 277.0),
new DataPoint (new DateTime(2014,12,31), 328.5),
new DataPoint (new DateTime(2015,12,31), 297.0),
new DataPoint (new DateTime(2016,12,31), 255.3),
new DataPoint (new DateTime(2017,12,31), 173.5),
new DataPoint (new DateTime(2018,12,31), 131.8)
}
}
};
}
public class DataSeries {
public string Name { get; set; }
public ObservableCollection<DataPoint> Values { get; set; }
}
public class DataPoint {
public DateTime Argument { get; set; }
public double Value { get; set; }
public DataPoint(DateTime argument, double value) {
Argument = argument;
Value = value;
}
}
}
}
Imports System
Imports System.Collections.ObjectModel
Namespace SideBySideBar2DChart
Public Partial Class Window1
Inherits Window
Public Sub New()
InitializeComponent()
End Sub
End Class
Public Class ChartViewModel
Private _Data As System.Collections.ObjectModel.ObservableCollection(Of SideBySideBar2DChart.ChartViewModel.DataSeries)
Public Property Data As ObservableCollection(Of DataSeries)
Get
Return _Data
End Get
Private Set(ByVal value As ObservableCollection(Of DataSeries))
_Data = value
End Set
End Property
Public Sub New()
Data = New ObservableCollection(Of DataSeries) From {
New DataSeries With {
.Name = "DevAV North",
.Values = New ObservableCollection(Of DataPoint) From {
New DataPoint(New DateTime(2013, 12, 31), 362.5),
New DataPoint(New DateTime(2014, 12, 31), 348.4),
New DataPoint(New DateTime(2015, 12, 31), 279.0),
New DataPoint(New DateTime(2016, 12, 31), 230.9),
New DataPoint(New DateTime(2017, 12, 31), 203.5),
New DataPoint(New DateTime(2018, 12, 31), 197.1)
}
},
New DataSeries With {
.Name = "DevAV South",
.Values = New ObservableCollection(Of DataPoint) From {
New DataPoint(New DateTime(2013, 12, 31), 277.0),
New DataPoint(New DateTime(2014, 12, 31), 328.5),
New DataPoint(New DateTime(2015, 12, 31), 297.0),
New DataPoint(New DateTime(2016, 12, 31), 255.3),
New DataPoint(New DateTime(2017, 12, 31), 173.5),
New DataPoint(New DateTime(2018, 12, 31), 131.8)
}
}
}
End Sub
Public Class DataSeries
Public Property Name As String
Public Property Values As ObservableCollection(Of DataPoint)
End Class
Public Class DataPoint
Public Property Argument As Date
Public Property Value As Double
Public Sub New(ByVal argument As Date, ByVal value As Double)
Me.Argument = argument
Me.Value = value
End Sub
End Class
End Class
End Namespace
The following code snippets (auto-collected from DevExpress Examples) contain references to the Legend property.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.
wpf-charts-add-custom-legend-item-to-legend/CS/CustomLegendItemSample/MainWindow.xaml#L23
<!--region #CustomItems-->
<dxc:ChartControl.Legend>
<dxc:Legend ItemVisibilityMode="AutoGeneratedAndCustom">
wpf-data-grid-display-chart-control-in-grid-details/CS/WpfApplication19/MainWindow.xaml#L37
</dxc:SimpleDiagram2D>
<dxc:ChartControl.Legend>
<dxc:Legend Visibility="Visible"/>
wpf-data-grid-create-master-detail-grid-in-code/CS/MasterDetailInCode/MainWindow.xaml#L34
</dxc:SimpleDiagram2D>
<dxc:ChartControl.Legend>
<dxc:Legend Visibility="Visible"/>
See Also