ColorSchemeEntry Class
A color scheme entry used to map the dimension values/measures and the specified color.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v18.2.Core.dll
Declaration
Remarks
The ColorScheme class provides access to 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.
- The ColorSchemeEntry.DimensionKeys collection contains ColorSchemeDimensionKey objects that allow you to specify the dimension and the corresponding dimension value. Use the Dimension.GetDimensionDefinition method to obtain the dimension definition and pass the returned object to the ColorSchemeDimensionKey constructor.
- The ColorSchemeEntry.MeasureKey property returns the ColorSchemeMeasureKey object that allows you to specify measures to be colored. Use the Measure.GetMeasureDefinition method to obtain the measure definition and pass the returned object to the ColorSchemeMeasureKey constructor.
- The ColorSchemeEntry.DataSource property specifies the data source containing the required dimensions and measures. The ColorSchemeEntry.DataMember property allows you to specify the required data member for the selected data source.
- The ColorSchemeEntry.ColorDefinition property allows you to specify the color used to color the dimension values/measures specified above. You can select the required color from the default palette or specify a custom color.
Example
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), ColorSchemeEntry
objects are created. The ColorSchemeEntry
class allows you to specify the following properties:
- The ColorSchemeEntry.DataSource property specifies a data source containing dimension values to be colored.
- The ColorSchemeEntry.DimensionKeys property allows you to specify required dimension values.
- The ColorSchemeEntry.ColorDefinition property sets the color used to color specified dimension values.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-a-dashboard-color-scheme-t184002.
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();
// Creates a color table containing dimension values, measures and corresponding colors.
DataTable colorTable = CreateColorTable();
// Loads a dashboard from the XML file.
Dashboard dashboard = new Dashboard(); dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
IDashboardDataSource dataSource = dashboard.DataSources["dataSource1"];
// Specifies the coloring mode for the specified 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;
}
// Creates color scheme entries used 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;
}
}
}