SeriesKeyColorColorizer.Keys Property

Returns the collection of keys that the colorizer uses to assign colors to series.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v23.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

public KeyCollection Keys { get; }

VB.NET

Public ReadOnly Property Keys As KeyCollection

Property Value

Type	Description
KeyCollection	The collection of key objects that the colorizer uses to assign colors to series.

Remarks

When the colorizer starts painting series and its Keys collection is empty, the colorizer fills this collection using the unique series data member values.

Example

The following code demonstrates how to configure the colorizer and uses the properties below:

Property	Description
SeriesKeyColorColorizer.PaletteName	Gets or sets the name of the palette whose colors the colorizer assigns to series.
SeriesKeyColorColorizer.Keys	Returns the collection of keys that the colorizer uses to assign colors to series.
SeriesKeyColorColorizer.KeyProvider	Gets or sets the object that converts series data member values into series color keys.

C#

SeriesKeyColorColorizer colorizer = new SeriesKeyColorColorizer() {
    // The colorizer uses the specified palette's colors.
    PaletteName = "Office2013",
    // The custom key provider that the colorizer uses 
    // to convert the series data member's value to another object.
    KeyProvider = new CustomKeyProvider()
};
// Keys that colorizer assigns to its palette's colors to create key-color pairs.
// The first key forms a pair with the first color, the second key with the second color, etc.
colorizer.Keys.AddRange(new object[]{"One", "Two", "Three"});
chartControl.SeriesTemplate.SeriesColorizer = colorizer;

VB.NET

Dim colorizer As SeriesKeyColorColorizer = New SeriesKeyColorColorizer() With { _
    ' The colorizer uses the specified palette's colors.
    .PaletteName = "Office2013", _
    ' The custom key provider that the colorizer uses 
    ' to convert the series data member's value to another object.
    .KeyProvider = new CustomKeyProvider() _
}
' Keys that colorizer assigns to its palette's colors to create key-color pairs.
' The first key forms a pair with the first color, the second key with the second color, etc.
colorizer.Keys.AddRange(new object[]{"One", "Two", "Three"})
chartControl.SeriesTemplate.SeriesColorizer = colorizer