CustomPaletteWebEventArgs.Palette Property

Gets or sets a palette used to color dashboard item elements.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v21.2.Web.dll

NuGet Package: DevExpress.Web.Dashboard.Common

Declaration

C#

public DashboardPalette Palette { get; set; }

VB.NET

Public Property Palette As DashboardPalette

Property Value

Type	Description
DashboardPalette	A DashboardPalette object that specifies a palette used to color dashboard item elements.

Remarks

DevExpress Dashboard uses a set of 20 unique colors from the default palette. You can use the static read-only DashboardPalette.Default field to get the default palette.

You can create your own palette with custom colors with the following events:

• ASPxDashboard.CustomPalette
• DashboardConfigurator.CustomPalette

The following example illustrates how to substitute the default palette with a custom palette for a specified dashboard. Create and initialize the DashboardPalette class instance and assign the resulting object to the e.Palette event parameter:

View Example: Dashboard for ASP.NET Core - How to Customize the Color Palette

using DevExpress.DashboardCommon;
using DevExpress.DashboardWeb;
using System.Drawing;

void Default_CustomPalette(object sender, CustomPaletteWebEventArgs e) {
    if (e.DashboardId == "SalesByCategory") {

        // Create a new custom palette.
        List<Color> customColors = new List<Color>();
        customColors.Add(Color.LightBlue);
        customColors.Add(Color.Aquamarine);
        customColors.Add(Color.SkyBlue);
        customColors.Add(Color.LightCoral);
        customColors.Add(Color.Tomato);
        customColors.Add(Color.IndianRed);
        customColors.Add(Color.Violet);
        customColors.Add(Color.Plum);
        customColors.Add(Color.MediumOrchid);

        // Assign a newly created custom palette to the Web Dashboard.
        e.Palette = new DashboardPalette(customColors);
    }
}

The image below displays the resulting palette: