Skip to main content
Skip table of contents

Calendar Heatmap Configuration Options

Gadget Configurations Guide


The following options can be configured 

SettingsDescription
TitleThe title to be displayed within the gadget title bar. Refer to the blue title bar in the picture above
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 9 Aug 2016,

  • Last Year - Full Calendar Year from 1 Jan 2015 to 31 Dec 2015
  • This Year - Full Calendar Year from 1 Jan 2016 to 31 Dec 2016
  • Rolling Window (Last Year) - 01 Aug 2015 to 31 Aug 2016
  • Rolling Window (This Year) - 01 Aug 2016 to 31 Aug 2017
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 FilterThe 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.

The numbers in the red circles are the intervals. It will determine the range of numbers for each coloured boxes

It must be a set of 4 numbers separated by commas and does not require the percentage symbol.

For versions after 1.3.0/2.3.0

There is no longer a limit to 4 intervals

See Calendar Heatmap Gadget 1.3.0/2.3.0 Release Notes


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 (question) symbol will show you the intervals for the current entered values

Color

The color scheme to use for heatmap

  • Red
  • Orange
  • Green
  • Blue
  • Purple

Refer to Calendar Heatmap Gadget 1.3.0/2.3.0 Release Notes for more detail.


Tips and Tricks

For versions 1.2.0/2.2.0 and earlier


If you only need 3 colours, you can set the remaining intervals to be same

E.g. Setting the interval 10,20,20,20,20 for fixed interval will result in the following criteria

GrayLightest GreenLighter GreenGreenDarker GreenDarkest Green
01 to 9 issues10 to 19 issuesN/AN/A20 issues or more



JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.