"jiraBiDimensionalGridChart" Macro
Reference
Description
Displays a table crossing two JIRA fields, in which each cell counts the issues having both values, using the statistics JIRA computes itself. The issues are selected by a JQL query or by the id of a filter saved in JIRA.
The Macro always starts a new block: it cannot be used inline.
Usage
The Macro has no content: everything is passed as parameters. Either id or url must be set to designate the JIRA instance, and either query or filterId to designate the issues. xAxisField and yAxisField are always mandatory, and choose the field laid out across the columns and the field laid out down the rows.
{{jiraBiDimensionalGridChart id="..." url="..." xAxisField="..." yAxisField="..." query="..." filterId="..." numberOfResults="..." sortAscending="..." sortNatural="..."/}}Parameters
| Name | Mandatory | Allowed Values | Default Value | Description |
|---|---|---|---|---|
| xAxisField | Yes | ASSIGNEE, REPORTER, STATUS, FIX_VERSION, COMPONENT, PRIORITY, TYPE | N/A | The field displayed in each column. |
| yAxisField | Yes | ASSIGNEE, REPORTER, STATUS, FIX_VERSION, COMPONENT, PRIORITY, TYPE | N/A | The field displayed in each row. |
| id | id or url | An instance id defined in the wiki administration | N/A | The JIRA instance to query. Recommended over url, because the URL is then defined in a single place and the instance can authenticate. |
| url | id or url | A JIRA instance URL | N/A | The JIRA instance to query, given directly by its URL. |
| query | query or filterId | A JQL query | N/A | The query selecting the issues to count. Ignored when filterId is set. |
| filterId | query or filterId | The id of a filter saved in JIRA, with or without the filter- prefix | N/A | The saved JIRA filter selecting the issues to count. Takes precedence over query. |
| numberOfResults | No | A positive number | 5 | The highest number of results JIRA returns for the table. |
| sortAscending | No | true, false | true | Whether the results are sorted ascending rather than descending. |
| sortNatural | No | true, false | true | Whether the results are sorted by the natural order of the field. Set it to false to sort by the totals instead. |
Examples
Crossing assignee and component
{{jiraBiDimensionalGridChart xAxisField="ASSIGNEE" yAxisField="COMPONENT" url="https://jira.xwiki.org" filterId="16802"/}}
Crossing fixed version and reporter, sorted by the totals
{{jiraBiDimensionalGridChart xAxisField="FIX_VERSION" yAxisField="REPORTER" url="https://jira.xwiki.org" filterId="16802" numberOfResults="10" sortAscending="false" sortNatural="false"/}}
Selecting the issues with a JQL query
{{jiraBiDimensionalGridChart xAxisField="STATUS" yAxisField="PRIORITY" id="xwikiorg" query="project=XWIKI"/}}Setting the parameters in the WYSIWYG editor
FAQ
Why does the grid show fewer rows than I expect?
Because numberOfResults caps how many results JIRA returns, and it defaults to 5.
Which parameter is the row and which is the column?
xAxisField gives the columns and yAxisField gives the rows.
Is the output really a chart?
No, it is a table of counts, despite the Macro name; only jiraPieChart and jiraCreatedVsResolvedChart draw a graph.
