SeriesKeyColorColorizer.KeyProvider Property

Gets or sets the object that converts series data member values into series color keys.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

[Browsable(false)]
[DefaultValue(null)]
public IColorizerKeyProvider KeyProvider { get; set; }

VB.NET

<DefaultValue(Nothing)>
<Browsable(False)>
Public Property KeyProvider As IColorizerKeyProvider

Property Value

Type	Default	Description
IColorizerKeyProvider	null	The object that converts series data member values into series keys.

Remarks

You can use custom logic to assign color keys to series. Create a custom key provider that inherits the IColorizerKeyProvider interface and implement the GetKey(Object) method for this purpose. Assign an instance of this provider to the SeriesKeyColorColorizer.KeyProvider property as follows:

C#

using DevExpress.XtraCharts;
using System;
using System.Data;
using System.Windows.Forms;

namespace ColorKeyProvider {
   public partial class Form1 : Form {
       public Form1() {
           InitializeComponent();
       }
       private void Form1_Load(object sender, EventArgs e) {
           chartControl1.DataSource = GetData();
           chartControl1.SeriesDataMember = "Region";
           chartControl1.SeriesTemplate.ArgumentDataMember = "Year";
           chartControl1.SeriesTemplate.View = new LineSeriesView();
           chartControl1.SeriesTemplate.ValueDataMembers.AddRange(new string[] { "Sales" });
           SeriesKeyColorColorizer colorizer = new SeriesKeyColorColorizer() {
               PaletteName = "Slipstream",
               // Assign a provider instance to the KeyProvider property.
               KeyProvider = new CustomKeyProvider(),
           };
           colorizer.Keys.AddRange(new object[] { "key1", "key2", "key3" });
           chartControl1.SeriesTemplate.SeriesColorizer = colorizer;
       }
       internal static DataTable GetData() {
           DataTable table = new DataTable();
           table.Columns.AddRange(new DataColumn[] { new DataColumn("Region", typeof(string)),
                                                 new DataColumn("Year", typeof(int)),
                                                 new DataColumn("Sales", typeof(decimal)) });
           table.Rows.Add("Asia", 2017, 4.2372D);
           table.Rows.Add("Asia", 2018, 4.7685D);
           table.Rows.Add("Asia", 2019, 5.2890D);
           table.Rows.Add("Australia", 2017, 1.7871D);
           table.Rows.Add("Australia", 2018, 1.9576D);
           table.Rows.Add("Australia", 2019, 2.2727D);
           table.Rows.Add("Europe", 2017, 3.0884D);
           table.Rows.Add("Europe", 2018, 3.3579D);
           table.Rows.Add("Europe", 2019, 3.7257D);
           table.Rows.Add("North America", 2017, 3.4855D);
           table.Rows.Add("North America", 2018, 3.7477D);
           table.Rows.Add("North America", 2019, 4.1825D);
           table.Rows.Add("South America", 2017, 1.6027D);
           table.Rows.Add("South America", 2018, 1.8237D);
           table.Rows.Add("South America", 2019, 2.1172D);

           return table;
       }
   }
   //Implement a custom key provider class. 
   internal class CustomKeyProvider : IColorizerKeyProvider {
       public object GetKey(object colorKey) {
           string seriesName = colorKey.ToString();
           if (seriesName.StartsWith("A"))
               return "key1";
           if (seriesName.Contains("America")) {
               return "key2";
           }
           else
               return "key3";
       }
   }
}

VB.NET

Imports DevExpress.XtraCharts
Imports System
Imports System.Data
Imports System.Windows.Forms

Namespace ColorKeyProvider
   Public Partial Class Form1
       Inherits Form

       Public Sub New()
           InitializeComponent()
       End Sub

       Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
           chartControl1.DataSource = GetData()
           chartControl1.SeriesDataMember = "Region"
           chartControl1.SeriesTemplate.ArgumentDataMember = "Year"
           chartControl1.SeriesTemplate.View = New LineSeriesView()
           chartControl1.SeriesTemplate.ValueDataMembers.AddRange(New String() {"Sales"})
           Dim colorizer As SeriesKeyColorColorizer = New SeriesKeyColorColorizer() With {
               .PaletteName = "Slipstream",
               ' Assign a provider instance to the KeyProvider property.
               .KeyProvider = New CustomKeyProvider()
           }
           colorizer.Keys.AddRange(New Object() {"key1", "key2", "key3"})
           chartControl1.SeriesTemplate.SeriesColorizer = colorizer
       End Sub

       Friend Shared Function GetData() As DataTable
           Dim table As DataTable = New DataTable()
           table.Columns.AddRange(New DataColumn() {New DataColumn("Region", GetType(String)), New DataColumn("Year", GetType(Integer)), New DataColumn("Sales", GetType(Decimal))})
           table.Rows.Add("Asia", 2017, 4.2372R)
           table.Rows.Add("Asia", 2018, 4.7685R)
           table.Rows.Add("Asia", 2019, 5.2890R)
           table.Rows.Add("Australia", 2017, 1.7871R)
           table.Rows.Add("Australia", 2018, 1.9576R)
           table.Rows.Add("Australia", 2019, 2.2727R)
           table.Rows.Add("Europe", 2017, 3.0884R)
           table.Rows.Add("Europe", 2018, 3.3579R)
           table.Rows.Add("Europe", 2019, 3.7257R)
           table.Rows.Add("North America", 2017, 3.4855R)
           table.Rows.Add("North America", 2018, 3.7477R)
           table.Rows.Add("North America", 2019, 4.1825R)
           table.Rows.Add("South America", 2017, 1.6027R)
           table.Rows.Add("South America", 2018, 1.8237R)
           table.Rows.Add("South America", 2019, 2.1172R)
           Return table
       End Function
   End Class

   'Implement a custom key provider class. 
   Friend Class CustomKeyProvider
       Inherits IColorizerKeyProvider

       Public Function GetKey(ByVal colorKey As Object) As Object
           Dim seriesName As String = colorKey.ToString()
           If seriesName.StartsWith("A") Then Return "key1"

           If seriesName.Contains("America") Then
               Return "key2"
           Else
               Return "key3"
           End If
       End Function
   End Class
End Namespace

Result: