Customize Dashboard Colors

• Aug 01, 2019
• 4 minutes to read

The Web Dashboard provides the capability to manage the coloring of dashboard item elements in the Designer mode. To learn more, see Coloring.

The ASPxClientDashboard allows you to color specified dashboard item elements (for instance, chart series points, pie segments or scatter chart points) at runtime by handling the ASPxClientDashboard.ItemElementCustomColor event. For instance, this can be used to color specified elements based on their values. The image below illustrates the Chart dashboard item whose bars are colored based on the their values: values that exceed 200k are colored in green, values below 100k are colored in red, and values that fall into the range between 100k and 200k are colored in gray.

The ASPxClientDashboardItemElementCustomColorEventArgs class exposes the following members that allow you to color the required element.

• Use the ASPxClientDashboardItemElementCustomColorEventArgs.ItemName property to obtain the component name of the dashboard item for which the event was raised.

• The ASPxClientDashboardItemElementCustomColorEventArgs.GetTargetElement method returns the axis point tuple that corresponds to the current dashboard item element.

  The ASPxClientDashboardItemElementCustomColorEventArgs.GetMeasures method returns measures corresponding to the current dashboard item element. Use the ASPxClientDashboard.GetItemData method to create the required tuple (using the ASPxClientDashboardItemData.CreateTuple method) and to obtain dashboard item measures (using the ASPxClientDashboardItemData.GetMeasures method).

• Use the ASPxClientDashboardItemElementCustomColorEventArgs.SetColor method to set the color of the current dashboard item element.

Note

By default, the Chart dashboard item colors lines (or fills areas) for the Line/Area series types using the color of the first series point. For these lines/areas, the ASPxClientDashboardItemElementCustomColorEventArgs.GetTargetElement method returns a tuple that does not contain the ASPxClientDashboardItemDataAxisPoint on the DashboardDataAxisNames.ChartArgumentAxis.

Example

The following example demonstrates how to color dashboard item elements using the ASPxClientDashboard.ItemElementCustomColor event.

In this example, chart series points, whose values exceed specified thresholds, are colored in green. Chart series points, whose values fall below specified thresholds, are colored in red.Pie segments, whose contributions in total fall below the specified threshold, are colored in orange.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/aspxdashboard-how-to-color-dashboard-item-elements-t491831.

WebForm1.aspx.cs

using System;

namespace ASPxDashboard_ElementCustomColor
{
    public partial class WebForm1 : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            ASPxDashboard1.DashboardXmlPath= Server.MapPath("App_Data/dashboard1.xml");
        }
    }
}

ElementCustomColor.js (C#)

var argumentAxis = DashboardDataAxisNames.ChartArgumentAxis,
    seriesAxis = DashboardDataAxisNames.ChartSeriesAxis;

function setColors(args) {
    var chartClientData = webViewer.GetItemData("chartDashboardItem1"),
        pieClientData = webViewer.GetItemData("pieDashboardItem1");
    var currentElement = args.GetTargetElement();

    if (args.ItemName == "chartDashboardItem1") {
        var country = currentElement.GetAxisPoint(DashboardDataAxisNames.ChartSeriesAxis).GetValue();
        var value = chartClientData.GetSlice(currentElement.GetAxisPoint(argumentAxis)).
                                    GetSlice(currentElement.GetAxisPoint(seriesAxis)).
                                    GetMeasureValue(chartClientData.GetMeasures()[0].Id).GetValue();
        if (country == "UK" && value > 50000 || country == "USA" && value > 100000)
            args.SetColor("#33CC66");
        else
            args.SetColor("#CC6633");
    }

    if (args.ItemName == "pieDashboardItem1") {
        var value = pieClientData.GetSlice(currentElement.GetAxisPoint(argumentAxis)).
                                  GetMeasureValue(pieClientData.GetMeasures()[0].Id).GetValue();
        if (value < 100000)
            args.SetColor("#FFCC66");
    }   
};

WebForm1.aspx (C#)

<%@ Page Language="C#" AutoEventWireup="true" 
    CodeBehind="WebForm1.aspx.cs" 
    Inherits="ASPxDashboard_ElementCustomColor.WebForm1" %>

<%@ Register Assembly="DevExpress.Dashboard.v16.2.Web, Version=16.2.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" 
    Namespace="DevExpress.DashboardWeb" TagPrefix="dx" %>

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div style="position:absolute; left:0; right:0; top:0; bottom:0;">
        <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" 
            WorkingMode="Viewer" 
            ClientInstanceName="webViewer"
            ClientSideEvents-ItemElementCustomColor="function(s, e) { setColors(e); }" 
            Height="100%" Width="100%">
        </dx:ASPxDashboard>
    </div>
    </form>
</body>
</html>
<script type="text/javascript" src="<%= Page.ResolveClientUrl("~/Scripts/ElementCustomColor.js") %>"></script>

ElementCustomColor.js (VB.NET)

var argumentAxis = DashboardDataAxisNames.ChartArgumentAxis,
    seriesAxis = DashboardDataAxisNames.ChartSeriesAxis;

function setColors(args) {
    var chartClientData = webViewer.GetItemData("chartDashboardItem1"),
        pieClientData = webViewer.GetItemData("pieDashboardItem1");
    var currentElement = args.GetTargetElement();

    if (args.ItemName == "chartDashboardItem1") {
        var country = currentElement.GetAxisPoint(DashboardDataAxisNames.ChartSeriesAxis).GetValue();
        var value = chartClientData.GetSlice(currentElement.GetAxisPoint(argumentAxis)).
                                    GetSlice(currentElement.GetAxisPoint(seriesAxis)).
                                    GetMeasureValue(chartClientData.GetMeasures()[0].Id).GetValue();
        if (country == "UK" && value > 50000 || country == "USA" && value > 100000)
            args.SetColor("#33CC66");
        else
            args.SetColor("#CC6633");
    }

    if (args.ItemName == "pieDashboardItem1") {
        var value = pieClientData.GetSlice(currentElement.GetAxisPoint(argumentAxis)).
                                  GetMeasureValue(pieClientData.GetMeasures()[0].Id).GetValue();
        if (value < 100000)
            args.SetColor("#FFCC66");
    }   
};

WebForm1.aspx (VB.NET)

<%@ Page Language="vb" AutoEventWireup="true" 
    CodeBehind="WebForm1.aspx.vb" 
    Inherits="ASPxDashboard_ElementCustomColor.WebForm1" %>

<%@ Register Assembly="DevExpress.Dashboard.v16.2.Web, Version=16.2.5.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" 
    Namespace="DevExpress.DashboardWeb" TagPrefix="dx" %>

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
</head>
<body>
    <form id="form1" runat="server">
    <div style="position:absolute; left:0; right:0; top:0; bottom:0;">
        <dx:ASPxDashboard ID="ASPxDashboard1" runat="server" 
            WorkingMode="Viewer" 
            ClientInstanceName="webViewer"
            ClientSideEvents-ItemElementCustomColor="function(s, e) { setColors(e); }" 
            Height="100%" Width="100%">
        </dx:ASPxDashboard>
    </div>
    </form>
</body>
</html>
<script type="text/javascript" src="<%=Page.ResolveClientUrl("~/Scripts/ElementCustomColor.js")%>"></script>

WebForm1.aspx.vb

Imports System

Namespace ASPxDashboard_ElementCustomColor
    Partial Public Class WebForm1
        Inherits System.Web.UI.Page

        Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
            ASPxDashboard1.DashboardXmlPath= Server.MapPath("App_Data/dashboard1.xml")
        End Sub
    End Class
End Namespace