Color Coding

Groups

A color group lets you choose how to color code events. A group has a set of items that relate values of an event property, as found in the event map routes/scheduler.event, to color swatches. If an event does not have a matching item, the default swatch is applied.

The event map has a swatch property that can also specify the swatch to apply, overriding the item swatch. When the group eventswatch option is true the swatch from the event is applied, if it is false the swatch from the item takes priority.

A color group applies a Palette that defines the available swatches to use. Scheduler users can change the default palette to other available options, which changes the swatches on the items. Your selected preferences are saved to your local computer and won’t affect anyone else’s settings.

The following color groups are pre-configured and the default selected group is Task Priority:

• Task Priority

• Task Status

• Task Type

• Case Type

Items

An item relates a value of an event property to a color. To do this, each item defines a unique value in its ID and specifies a color swatch. If the item has no swatch defined, one will automatically be assigned based on its index in the palette swatches. Assigning an item a swatch not supported in the palette will result in a default swatch being applied. An item can optionally define cluster which specifies how the color is applied to the map marker clusters.

Scheduler users can change the swatch for each item with another swatch within the same palette. Your changes are saved to your local computer and won’t affect anyone else’s changes.

Palettes

Palettes are combinations of 8 swatches supported in the scheduler, and you can't add custom palettes.

The following palettes are available and the default palette is Rainbow:

• Rainbow

• Cool

• Warm

• Contrast

Swatches

Swatches are the colors available in each of the palettes. You can't add new swatches or change their colors.

The swatches for the available palettes are listed below:

The swatches available to events are listed below:

Adding a Color Group

To apply this to the task priority use case, set up the group as follows:

• Setting group object name to any unique descriptive value.

• Setting label property to the text Priority.

• Setting column property to the event mapped field priority.

• Setting items property to an array of objects representing the values high, medium and low.

• Set the palette property to Rainbow, which is one of the available palette options.

• For each item, set the swatch property to a specific swatch name from the Rainbow palette.

• Set the eventswatch flag to true to use the color swatch from the event.

For example:

            {
    "colour": {
        "group": {
            "mypriority": {
                "label": "Priority",
                "column": "priority",
                "palette": "Rainbow",
                "items": [{ "id": "1", "label": "High", "swatch": "redpigment" }, { "id":"2", "label": "Medium", "swatch": "sizzlingsunrise" }, { "id": "3", "label": "Low","swatch": "skybluecrayola" }],
                "eventswatch": true
            }
        }
    }
} 

          

Removing a Color Group

If you want to remove a group from the options, set its group property to null.

For example:

            {
    "colour": {
        "group": {
            "priority": null
        }
    }
} 

          

Map Cluster Color

Map clusters give you an overview of tasks grouped on the map, helping you spot any unattended priority tasks and zoom in to see where they are.

You can set the color of a cluster by setting a cluster level for each item.

Any cluster with a task assigned 1 will use that task’s color, overriding all other task colors in the cluster. If there’s no 1 but a task with 2, the cluster uses that color, and so on for each next increment.

For group priority, set the item object’s cluster property to 1 for high-priority tasks. Then, any cluster with a high-priority task will display the high swatch color. Set the other items’ cluster property to the next increment values: 2, 3, and so on.

If the cluster property isn’t set on an item, it’s ignored for cluster color. If none of the items have this property, the cluster shows the default dark color.

For example:

            {
    "colour": {
        "group": {
            "mypriority": {
                "label": "Priority",
                "column": "priority",
                "palette": "Rainbow",
                "items": [{ "id": "1", "label": "High", "swatch": "redpigment", "cluster": "1" }, { "id":"2", "label": "Medium", "swatch": "sizzlingsunrise", "cluster": "2" }, { "id":"3", "label": "Low", "swatch": "skybluecrayola", "cluster": "3" }],
                "eventswatch": true
            }
        }
    }
} 

          

Read Only Mode

Read-only mode stops users from changing the swatches for each group item, but they can still pick color groups with the last palettes and swatches set before read-only was turned on.

To make colors read-only, set the readonly property to true.

For example:

            {
    "colour": {
        "readonly": true
    }
} 

          

Disabling the Color Feature

Sometimes you might need to disable colors. To do this, set the enable property to false.

For example:

            {
    "colour": {
        "enabled":  false
    }
}