Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 to 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 . It is much more customizable and based on a rich filter instead of a Jira-saved search. The gadget add thus adds several new features: 

  • the collection of issues used to display the graph can be

    furthered

    further filtered using Rich Filter Controller gadgets;

  • the gadget itself can further refine the results by applying a gadget-specific JQL that we

    call 

    call a 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.

...

Tip
title

Rich Filter Extensions

Rich filter extensions are separate Jira apps that can be installed on top of the Rich Filters for Jira Dashboards app to extend the rich filters and rich filter gadgets with new specific functionality.

New bar chart options are available if you add any of the these extensions:

Configuring the Rich Filter Date Bar Chart Gadget

Add a new or edit an existing Rich Filter Date Bar 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

You can optionally customize the gadget's title

of the gadget. If left blank, the

. The default title will be Rich Filter Date Bar Chart if left blank.

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 desired filter

you need

.

Info

The gadgets’ configuration forms only show the rich filters you are allowed to view. See the section on permissions for details.

Tip

The link in the description line below the Rich Filter button opens a new page with the configuration of the

selected rich

selected rich filter.

Image Removed
Image Added

 Also

 Also, when the gadget is in display mode, you can navigate directly to

the

its rich filter

of the gadget

using the Rich Filter option in the menu at the top right of the gadget.

Image Removed
Image Added


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.

Date field

This setting is mandatory and specifies the

date

date or date time issue field on which the chart is based.

Image Removed
Image Added

Aggregation periods

The length of the periods is to be represented on the chart. It can be

:

Hours (only for date/time fields), Days, Weeks, Months, Quarters, or Years.

Time range





Together with its subsettings, this specifies the total time span for which the results will be computed. 

The time range subsettings depend on the option selected in the Time range drop-down as described below.

Time range

Time range subsetting

Description

Number of periods

Number of periods

Enter a number of periods. The time range corresponds to the specified number of consecutive aggregation periods.

Direction

Select how the periods are positioned relative to the current period. The possible options are:

  • Past – the time range includes past periods and the current period

  • Future – the time range includes the current period and future periods

  • Past & Future – the time range includes past periods, the current period, and future periods, with the current period in the middle of the range

Tip

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 any 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 see statistics for the issues

that are

due soon

,

or Past & Future to also see the statistics for overdue issues.

Between dates

Start date

End date

Enter the two dates that define the limits of the time range (both specified dates are inclusive).

The inputs can be selected from a date picker or entered manually as a calendar

 date

 date ("yyyy/MM/dd" or "yyyy-MM-dd") or as a time relative to the present (e.g. "-5d", "4w 2d").

Contextual options


These

are

predefined Time range options

which

depend on the selected Aggregation period. 

Possible options are: This year, Last year, This quarter, Last quarter, This month, Last month. 

Split Type

You can, optionally, split the data on each period

in

into sub-categories.

Image Removed
Image Added

The split categories can be based on:

  • Predefined criteriaResolved/Unresolved or Status Category
    Image Modified

  • Static filters – any static filter can be used to easily highlight a sub-set of the issues displayed in any aggregation period

Image Removed
  • Image Added
  • Smart filters – any smart filter (having label and color) can be used to

easily
  • split the data

in
  • into several categories easily

    Image Modified

Split Layout

This setting applies only if the Split Type is based on a smart filter and can take one of the two values:

  • Stacked Columns – each period is represented by a single column, which is divided

in
  • into categories based on the smart filters' clauses

    Image Modified
  • Clustered Columns

each period is represented by
  • a cluster of columns represents each period, one column for each category based on the

smart
  • smart filters' clauses

    Image Modified
Info

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.

Display Type

It can be:

  • Period value – shows the values of each

individual
  • period.

  • Cumulative trend – progressively adds the values from the previous periods. It includes only the issues starting with the first period of the graph.

  • Cumulative total – progressively adds the values from the previous periods. It also includes the issues before the first period.

Image Removed Image Removed Image Removed
Image AddedImage AddedImage Added

Values

Select the output type to be computed for each aggregation period. There are three kinds of possible values:

  • Issue Count: computes the number of issues in each period.

  • Numeric: computes the sum of a numeric field for all issues in each period. For instance,

if using
  • Jira Software

, the gadget
  • can show

how many Story Points there are
  • the number of story points for each period.

  • Time Tracking: computes the sum of a time tracking field for all issues in each period.

Image Removed
Image Added