Document toolboxDocument toolbox

Calendar Heatmap Configuration Options

The following options can be configured 

Settings

Description

Settings

Description

Title

Optional text that you can put as an instruction or helper text for the viewers

Date Type

The date field to be used for grouping the issues from the saved filter.

It can either be a

  • Jira date system field

  • DatePicker custom field

  • DateTime Picker custom field

Date Period

The 12 month date period to display the calendar. There are 4 different modes. For example, if today is 22 Oct 2022,

  • Last Year - Full Calendar Year from 1 Jan 2021 to 31 Dec 2021

  • This Year - Full Calendar Year from 1 Jan 2022 to 31 Dec 2022

  • Rolling Window (Last Year) - 01 Oct 2021 to 31 Oct 2022

  • Rolling Window (This Year) - 01 Aug Oct to 31 Oct 2023

Highlight Today

This indicates whether current day should be highlighted on heat map

  • Yes - Today will be highlighted

  • No - Today will not be highlighted

Saved Filter

The Jira filter used for selecting the issues

Intervals Type

The color intensity is determined based on the no. of issues for each day.
This setting defines the usage of either absolute intervals or a percentage of total issues.

There are 2 options

  • Fixed Value - Legend intervals will be based on fixed values

  • Percentage - Legend intervals will be a percentage of total issues

Intervals

This setting indicates the range of values for each color intensity.
It must be a set of numbers separated by commas and does not require the percentage symbol.

Example

If intervals type is Fixed Value, the intervals (20,40,60,80) will be

  • less than 20 issues

  • 20 issues and less than 40 issues

  • 40 issues and less than 60 issues

  • 60 issues and less than 80 issues

  • 80 issues or more

If the interval type is Percentage, the intervals will change dynamically with respect to the total number of matching issues from the Saved Filter.

  • If there are 100 matching issues, the criteria will be same.

  • If there are 200 matching issues, the lightest color will be assigned to 40 issues or less (20% x 200 issues)

Hovering on the  symbol will show you the intervals for the current entered values

 

Color

The color scheme to use for heatmap

  • Red

  • Orange

  • Green

  • Blue

  • Purple