dashboard-devexpress-dot-dashboardcommon-ca8bd363.md
A color scheme used to color dashboard item elements.
Namespace : DevExpress.DashboardCommon
Assembly : DevExpress.Dashboard.v25.2.Core.dll
NuGet Package : DevExpress.Dashboard.Core
public class ColorScheme :
NotifyingCollection<ColorSchemeEntry>
Public Class ColorScheme
Inherits NotifyingCollection(Of ColorSchemeEntry)
The following members return ColorScheme objects:
You can color dashboard item elements in the following two ways.
Dashboard items that support color variation expose the ColoringOptions property. This property allows you to access color options. The DashboardItemColoringOptions object returned by this property exposes the DashboardItemColoringOptions.UseGlobalColors property. This property allows you to specify whether the dashboard item uses a global or local color scheme.
Dashboard items allow you to apply specific colors to dimension values/measures or their combinations.
Use the following properties to specify the color mode used to color the required dimension values/measures.
Use the ColorScheme class to access a collection of ColorSchemeEntry objects that allow you to map the required dimension values/measures and the specified color. To do this, use the following members.
Tip
Documentation:
Coloring
The following example demonstrates how to customize a dashboard color scheme to color specified dimension values using predefined colors.
In this example, the dashboard contains Pie and Chart dashboard items, whose dimension values are colored by hue. Dimension values and corresponding colors are stored in a data table.
To add custom colors to the dashboard color scheme (the Dashboard.ColorScheme property), create the ColorSchemeEntry objects.
The ColorSchemeEntry class has the following properties:
View Example: How to Customize a Dashboard Color Scheme
using System.Data;
using System.Drawing;
using DevExpress.XtraBars.Ribbon;
using DevExpress.DashboardCommon;
namespace Dashboard_Coloring {
public partial class Form1 : RibbonForm {
public Form1() {
InitializeComponent();
dashboardDesigner1.CreateRibbon();
// Create a color table that contains dimension values, measures and colors.
DataTable colorTable = CreateColorTable();
// Load a dashboard from the XML file.
Dashboard dashboard = new Dashboard(); dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
IDashboardDataSource dataSource = dashboard.DataSources["dataSource1"];
// Specify the coloring mode for the pie series, pie measures and chart argument.
PieDashboardItem pie1 = (PieDashboardItem)dashboard.Items["pieDashboardItem1"];
ChartDashboardItem chart1 = (ChartDashboardItem)dashboard.Items["chartDashboardItem1"];
pie1.SeriesDimensions[0].ColoringMode = ColoringMode.Hue;
pie1.ColoringOptions.MeasuresColoringMode = ColoringMode.Hue;
chart1.Arguments[0].ColoringMode = ColoringMode.Hue;
foreach (DataRow row in colorTable.Rows) {
dashboard.ColorScheme.Add(CreateColorSchemeEntry(row, dataSource, false));
dashboard.ColorScheme.Add(CreateColorSchemeEntry(row, dataSource, true));
}
dashboardDesigner1.Dashboard = dashboard;
}
// Create color scheme entries to map dimension values, measures and colors.
private ColorSchemeEntry CreateColorSchemeEntry(DataRow colorSchemeRecord,
IDashboardDataSource dataSource,
bool includeMeasures) {
DimensionDefinition categoryDefinition = new DimensionDefinition("CategoryName");
DimensionDefinition countryDefinition = new DimensionDefinition("Country");
MeasureDefinition priceDefinition = new MeasureDefinition("Extended Price");
ColorSchemeEntry entry = new ColorSchemeEntry();
entry.DimensionKeys.Add(new ColorSchemeDimensionKey(categoryDefinition,
colorSchemeRecord["CategoryName"]));
entry.DimensionKeys.Add(new ColorSchemeDimensionKey(countryDefinition,
colorSchemeRecord["Country"]));
if(includeMeasures)
entry.MeasureKey = new ColorSchemeMeasureKey(priceDefinition);
entry.ColorDefinition = new ColorDefinition((Color)colorSchemeRecord["color"]);
entry.DataSource = dataSource;
return entry;
}
private DataTable CreateColorTable() {
DataTable colorTable = new DataTable();
colorTable.Columns.Add("CategoryName", typeof(string));
colorTable.Columns.Add("Country", typeof(string));
colorTable.Columns.Add("measure", typeof(string));
colorTable.Columns.Add("color", typeof(Color));
colorTable.Rows.Add("Beverages", "UK", "Extended Price", Color.Red);
colorTable.Rows.Add("Beverages", "USA", "Extended Price", Color.Green);
return colorTable;
}
}
}
Imports System.Data
Imports System.Drawing
Imports DevExpress.XtraBars.Ribbon
Imports DevExpress.DashboardCommon
Namespace Dashboard_Coloring
Partial Public Class Form1
Inherits RibbonForm
Public Sub New()
InitializeComponent()
dashboardDesigner1.CreateRibbon()
' Create a color table that contains dimension values, measures and colors.
Dim colorTable As DataTable = CreateColorTable()
' Load a dashboard from the XML file.
Dim dashboard As New Dashboard()
dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
Dim dataSource As IDashboardDataSource = dashboard.DataSources("dataSource1")
' Specify the coloring mode for the pie series, pie measures and chart argument.
Dim pie1 As PieDashboardItem = CType(dashboard.Items("pieDashboardItem1"), PieDashboardItem)
Dim chart1 As ChartDashboardItem = CType(dashboard.Items("chartDashboardItem1"), ChartDashboardItem)
pie1.SeriesDimensions(0).ColoringMode = ColoringMode.Hue
pie1.ColoringOptions.MeasuresColoringMode = ColoringMode.Hue
chart1.Arguments(0).ColoringMode = ColoringMode.Hue
For Each row As DataRow In colorTable.Rows
dashboard.ColorScheme.Add(CreateColorSchemeEntry(row, dataSource, False))
dashboard.ColorScheme.Add(CreateColorSchemeEntry(row, dataSource, True))
Next row
dashboardDesigner1.Dashboard = dashboard
End Sub
' Create color scheme entries to map dimension values, measures and colors.
Private Function CreateColorSchemeEntry(ByVal colorSchemeRecord As DataRow, ByVal dataSource As IDashboardDataSource, ByVal includeMeasures As Boolean) As ColorSchemeEntry
Dim categoryDefinition As New DimensionDefinition("CategoryName")
Dim countryDefinition As New DimensionDefinition("Country")
Dim priceDefinition As New MeasureDefinition("Extended Price")
Dim entry As New ColorSchemeEntry()
entry.DimensionKeys.Add(New ColorSchemeDimensionKey(categoryDefinition, colorSchemeRecord("CategoryName")))
entry.DimensionKeys.Add(New ColorSchemeDimensionKey(countryDefinition, colorSchemeRecord("Country")))
If includeMeasures Then
entry.MeasureKey = New ColorSchemeMeasureKey(priceDefinition)
End If
entry.ColorDefinition = New ColorDefinition(DirectCast(colorSchemeRecord("color"), Color))
entry.DataSource = dataSource
Return entry
End Function
Private Function CreateColorTable() As DataTable
Dim colorTable As New DataTable()
colorTable.Columns.Add("CategoryName", GetType(String))
colorTable.Columns.Add("Country", GetType(String))
colorTable.Columns.Add("measure", GetType(String))
colorTable.Columns.Add("color", GetType(Color))
colorTable.Rows.Add("Beverages", "UK", "Extended Price", Color.Red)
colorTable.Rows.Add("Beverages", "USA", "Extended Price", Color.Green)
Return colorTable
End Function
End Class
End Namespace
Object Collection<ColorSchemeEntry> NotifyingCollection<ColorSchemeEntry> ColorScheme
See Also