This documentation relates to version 1.7 of the Rich Filters Add-on for JIRA. Documentation for previous versions is available via the documentation index.
The Rich Filter Date Bar Chart Chart Gadget displays a bar chart based on the values of a date or date/time field. It is somehow similar with JIRA’s built-in Recently Created Chart Gadget but unlike the built-in gadget which is always based on the Created date, the Rich Filter Date Bar Chart gadget can use any date field, it is a lot more customizable and it is based on a rich filter instead of a JIRA saved search. The gadget add thus several new features:
- the collection of issues used to display the graph can be furthered filtered using Rich Filter Controller gadgets;
- the gadget itself can further refine the results by applying gadget-specific JQL we call “working query”;
- it can be based on any JIRA date or date/time field, native (e.g. Created, Resolved, Due Date, etc.) or custom (i.e. Date Picker, Date Time Picker);
- it can further split the bars based on additional criteria: predefined options, static filters or smart filters;
- it supports two different layouts – stacked columns and clustered columns;
- the values used by the gadget can be customized (for instance, to show the sum of Story Points instead of the Issue Count);
- the gadget’s title can be customized.
Configuring the Rich Filter Date Bar Chart Gadget
Edit the gadget configuration as described in the following table:
|Title||Optionally, you can customize the title of the gadget. If left blank, the default title will be Rich Filter Date Bar Chart.|
Select the rich filter the gadget will use. This setting is required.
Click on the Rich Filter button to display the list of rich filters; you can either scroll through or use the search box to find the filter you need.
The gadgets’ configuration forms only show the rich filters you are allowed to view. See the section on permissions for details.
The link in the description line below the Rich Filter button opens a new page with the configuration of the selected rich filter.
Also, when the gadget is in display mode, you can navigate directly to the rich filter of the gadget using the Rich Filter option in the menu at the top right of the gadget.
|Working Query||The working query is a JQL query that is combined with the base filter of the rich filter before searching for issues. The working query is optional: if left empty, only the base JIRA filter and the quick filters affect the issues displayed.|
|Time Intervals||The length of the time intervals to be represented on the chart. It can be: Hourly (only for date/time fields), Daily, Weekly, Monthly, Quarterly, or Yearly.|
|Number of Intervals||The number of time intervals to be displayed in on the graph.|
Depending on the date field you use, you can select the period you wish to represent in the statistics gadget:
Fields like Created or Resolved always contain values that are in the past. Therefore you should always select Past for these fields as you will never find an issue created or resolved in the future.
Fields like Due Date contain values that can be both in the past and in the future. For this field it is more useful to select Future in order to easily see all the issues that are due soon or Past & Future to also see if there are overdue issues.
You can, optionally, split the data on each time interval in sub-categories.
The split categories can be based on:
This setting applies only if the Split Type is based on a smart filter and can take one of the two values:
The Stacked Columns layout can be used only if the split categories do not overlap. If the user selects Stacked Columns but the split categories overlap, the gadget will automatically use the Clustered Columns layout.
Select the output type to be computed for each time interval. There are two kinds of possible values:
In JIRA, numeric fields can also store negative values. The Rich Filter Date Bar Chart Gadget treats the negative values as zero.