This documentation relates to version 1.8 of the Rich Filters Add-on for JIRA. Documentation for previous versions is available via the documentation index.

The Rich Filter Pie Chart Gadget

The Rich Filter Pie Chart Gadget displays the collection of issues grouped by a specific field/criteria as a pie chart. It is similar to JIRA’s built-in Pie Chart Gadget, but it is based on a rich filter instead of a JIRA saved search and thus adds several new features:

  • the collection of issues used for the statistics can be furthered filtered using Rich Filter Controller gadgets;
  • the gadget itself can further refine the results by applying a gadget-specific JQL that we call “working query”;
  • the gadget can break down the results by an issue field or by a smart filter;
  • the value type displayed by the gadget can be customized (for instance, to show the sum of Story Points instead of the Issue Count);
  • the gadget supports multiple display layouts;
  • the gadget’s title can be customized.

Configuring the Rich Filter Pie Chart Gadget

Add a new or edit an existing Rich Filter Pie Chart Gadget in your JIRA dashboard. The configuration form of the gadget will be displayed:

Edit the gadget configuration as described in the following table:

Setting Description

Title

Optionally, you can customize the title of the gadget. If left blank, the default title will be Rich Filter Pie Chart.

Rich Filter

Select the rich filter the gadget will use.

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.

Statistic Type

Select the issue field or the smart filter on which the issues will be grouped. This setting is mandatory.

Pie charts are ideally suited to visual representation of statistics that split issues into separate categories. In JIRA, they work best if they are applied to single-value fields, or to smart filters with mutually exclusive clauses. Although you can use them with multi-valued fields, the resulting pie chart will be more difficult to interpret.

Values

Select the output type to be computed for each Statistic Type group. There are five kinds of possible values:

  • Issue Count: computes the number of issues in each group.
  • Time Tracking: computes the sum of one of the time-tracking fields (i.e. Original Estimate, Remaining Estimate, Time Spent) for all issues in each group.
  • Σ Time Tracking: the same as 'Time Tracking' but for each issue it also includes the values in its sub-tasks.
  • Numeric: computes the sum of a numeric field for all issues in each group. For instance, if using JIRA Agile, the gadget can show how many Story Points there are for each Statistic Type group.
  • Σ Numeric: the same as 'Numeric' but for each issue it also includes the values in its sub-tasks.

In JIRA, numeric fields can also store negative values. The Rich Filter Pie Chart Gadget treats the negative values as zero.

Layout

You can chose one of several layouts to display the results:

  • Pie Chart - compact: a modern pie-chart layout that doesn’t take a lot of space on the dashboard.
  • Pie Chart - classic: a larger layout, similar to JIRA’s built-in pie chart.
  • Sliced Bar Chart: the most compact layout, useful for data-dense dashboards.