SeriesColorizerBase.GetSeriesColor(Object, Palette) Method

Returns a color by the specified series identifier.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

public abstract Color GetSeriesColor(
    object seriesKey,
    Palette palette
)

VB.NET

Public MustOverride Function GetSeriesColor(
    seriesKey As Object,
    palette As Palette
) As Color

Parameters

Name	Type	Description
seriesKey	Object	The series identifier by which the color is selected.
palette	Palette	The chart’s current palette.

Returns

Type	Description
Color	The color assigned to the specified series identifier.

Example

The following code demonstrates how to implement a custom colorizer that should paint series using a non-predefined algorithm:

C#

class CustomSeriesColorizer : SeriesColorizer {
    List<object> metColors = new List<object>();

    public override Color GetSeriesColor(object seriesKey, Palette palette) {
        int keyIndex;
        if (metColors.Contains(seriesKey)) {
            keyIndex = metColors.IndexOf(seriesKey);
        } else {
            keyIndex = metColors.Count;
            metColors.Add(seriesKey);
        }
        return palette[keyIndex % palette.Count].Color;
    }

    protected override ChartElement CreateObjectForClone() {
        return new CustomSeriesColorizer();
    }
}

VB.NET

Class CustomSeriesColorizer Inherits SeriesColorizer
    Private metColors As List(Of Object) = New List(Of Object)

    Public Overrides Function GetSeriesColor(ByVal seriesKey As Object, ByVal palette As Palette) As Color
        Dim keyIndex As Integer
        If Me.metColors.Contains(seriesKey) Then
            keyIndex = Me.metColors.IndexOf(seriesKey)
        Else
            keyIndex = Me.metColors.Count
            Me.metColors.Add(seriesKey)
        End If
        Return palette((keyIndex Mod palette.Count)).Color
    End Function

    Protected Overrides Function CreateObjectForClone() As ChartElement
        Return New CustomSeriesColorizer
    End Function
End Class