Custom Event's Color

There are three ways you can specify a custom color for an event:

  1. To set color values in properties of the event object;
  2. To attach additional CSS class(es) to the event.
  3. To generate styles from data.

Specifying colors in properties of the event object

To specify a custom color for an event, it's enough to add 2 extra properties to the data object (or just one of them):

  • textColor - specifies the event's font color;
  • color - specifies the event's background color.

Setting the event's color in the data object

   {id:1, start_date:"2019-05-21",end_date:"2019-05-25",text:"Task1", color:"red"},
   {id:2, start_date:"2019-06-02",end_date:"2019-06-05",text:"Task2", color:"blue"}
scheduler.getEvent(1).color = "yellow";

Note, these are special properties. By default, the scheduler always checks whether an event has them and if it does, applies the related values to the event's container and text. Otherwise, the scheduler uses predefined colors for the event.

The properties can have any valid CSS color value, e.g. all of the following notations are valid:

ev.color = "#FF0000";
ev.color = "red";
ev.color = "rgb(255,0,0)";

Attaching additional CSS classes to an event

The second way to color an event is to apply additional CSS class(es) to it.


To apply a CSS class to an event, use the event_class template.
The default implementation of the template is:

scheduler.templates.event_class = function(start, end, ev){
     return "";

The function returns a string that will be added to the event class. So, you can return different classes depending on the event's state.

Related sample:  Coloring events


Let's assume, you want to have the events assigned to managers and employees in different colors: for managers - in green color, for employees - in orange. In this case, you do 2 things:

  1. Add an additional data property to the model and name it, for example 'type'. The property will store the type of the user : 'manager' or 'employee'.
  2. Specify the related CSS classes for these types, e.g. named as 'manager_event' and 'employee_event'. For such names, CSS definition will look as in:

    Redefining the default CSS classes

        .manager_event {
            --dhx-scheduler-event-background: #009966;
            --dhx-scheduler-event-color: black;
        .employee_event {
            --dhx-scheduler-event-background: #FF9933;
            --dhx-scheduler-event-color: black;
    For older versions of Scheduler (v6.0 and earlier), CSS variables are not available and events can be colored with following styles:
        /*event in day or week view*/
        .dhx_cal_event.manager_event div{
            background-color: #009966 !important;
            color: black !important;
        .dhx_cal_event.employee_event div{
            background-color: #FF9933 !important;
            color: black !important;
        /*multi-day event in month view*/
            background-color: #009966 !important;
            color: black !important;
            background-color: #FF9933 !important;
            color: black !important;
        /*event with fixed time, in month view*/
            color: black !important;
            color: black !important;
  3. And finally, override the event_class template

    Applying additional CSS classes to events:

    scheduler.templates.event_class = function (start, end, event) {
        if (event.type == 'manager') return "manager_event";
        return "employee_event"; 

Related sample:  Coloring events

Related sample:  Styling events with templates

Loading colors with data

If colors are a part of your data which comes from the backend, e.g. when task color is associated with a stage or a resource assigned to a task which can't be hardcoded on the page, it may be a good solution to generate styles from your data manually.

Let's suppose that you have the following collection of users that can be assigned to tasks. Task styles should be defined by the properties of user records:

    {"key":1, "label":"John", "backgroundColor":"#03A9F4", "textColor":"#FFF"},
    {"key":2, "label":"Mike", "backgroundColor":"#f57730", "textColor":"#FFF"},
    {"key":3, "label":"Anna", "backgroundColor":"#e157de", "textColor":"#FFF"},
    {"key":4, "label":"Bill", "backgroundColor":"#78909C", "textColor":"#FFF"},
    {"key":7, "label":"Floe", "backgroundColor":"#8D6E63", "textColor":"#FFF"}

In this use case, users and their colors are created and managed by different parts of the app and scheduler generally doesn't know user ids and their colors in advance.

This is what you can do in this case:

  • Define a named serverList for this collection
  • Load options to the page, either by using one of supported data formats or manually via a custom xhr

  • Once options are loaded, you can generate CSS styles from the data:

scheduler.attachEvent("onLoadEnd", function(){
    // use an arbitrary id for the style element
    var styleId = "dynamicSchedulerStyles";
    // in case you'll be reloading options with colors - reuse previously
    // created style element
    var element = document.getElementById(styleId);
        element = document.createElement("style"); = styleId;
    var html = [];
    var resources = scheduler.serverList("people");
    // generate css styles for each option and write css into the style element,
        html.push(`.event_resource_${r.key} {
    element.innerHTML = html.join("");
  • After that you'll be able to assign related classes you generated from the class template:
scheduler.templates.event_class = function (start, end, event) {
    var css = [];
        css.push("event_resource_" + event.owner_id);
    return css.join(" ");
Back to top