Insert the chart macro

The Chart macro allows you to display a chart based on tabular data. When you add the macro to a page, you:

• supply the data to be charted by the macro as a table in the placeholder of the macro.
• edit the macro parameters in the Macro Browser to configure the format of the chart.

Macro contents

Rendered chart

Using the Chart Macro

To add the Chart macro to a page:

1. Edit the page and use autocomplete to add the Chart macro. (Type '{chart}'.)
2. Enter your chart data as one or more tables in the body of the macro placeholder. (See the screenshot above.)
3. Click the macro placeholder and choose Edit.
4. Select a chart type using the Type parameter (see below).
5. Choose other parameter settings in the macro browser, as described below.
6. Click Refresh in the 'Preview' area, to check that the chart appears as you expect.
7. Click Save to add the chart to your page.
8. Click Save again when you are ready to save the page.

Parameters

Chart Type Parameters

These parameters determine the type of chart to display and the way the chart looks.

Display Control Parameters

Title and Label Parameters

Data Specification Parameters

The data for the chart is taken from tables found when the macro body is rendered. These options control how this data is interpreted. By default, numeric and date values are interpreted according to the Confluence global default language (locale) formats. If conversion fails, other languages defined in Confluence will be tried. Additional conversion options can be specified using the parameters below.

Color Parameters

Colors are specified using hexadecimal notation or HTML color names.

Axis Parameters

Depending on the chart type, the range and domain axis may be customized. These values are automatically generated based on the data but can be overridden by specifying one or more more of these parameters.

Pie Chart Parameters

Attachment Parameters

These are advanced options that can be used for chart versioning, to enable automation and to improve performance. Use these options carefully! Normally, the chart image is regenerated each time the page is displayed. These options allow for the generated image to be saved as an attachment and have subsequent access re-use the attachment. This can be useful especially when combined with the Cache Plugin to improve performance. Depending on the options chosen, chart images can be versioned for historical purposes.

Examples

Pie Chart

Parameters in Macro Browser		Data Table in Macro Placeholder	Rendered Chart
Type	pie	Fish Type 2011 Herring 9,500 Salmon 2,900 Tuna 1,500
Chart Title	Fish Sold 2011
Show Legend	true
Content Orientation	vertical

Bar Chart

Parameters in Macro Browser		Data Table in Macro Placeholder	Rendered Chart
Type	bar	Fish Type 2010 2011 Herring 9,500 8,300 Salmon 2,900 4,200 Tuna 1,500 1,500
Chart Title	Fish Sold
Show Legend	true

3D Bar Chart

Parameters in Macro Browser		Data Table in Macro Placeholder	Rendered Chart
Type	bar	2009 2010 2011 Revenue 12.4 31.8 41.1 Expense 43.6 41.8 31.1
Show in 3D	true
Opacity	50
Show Legend	true

Time Series Chart

Parameters in Macro Browser		Data Tables in Macro Placeholder		Rendered Chart
Type	Time Series	Month Revenue 1/2011 31.8 2/2011 41.8 3/2011 51.3 4/2011 33.8 5/2011 27.6 6/2011 49.8 7/2011 51.8 8/2011 77.3 9/2011 73.8 10/2011 97.6 11/2011 101.2 12/2011 113.7	Month Expenses 1/2011 41.1 2/2011 43.8 3/2011 45.3 4/2011 45.0 5/2011 44.6 6/2011 43.8 7/2011 51.8 8/2011 52.3 9/2011 53.8 10/2011 55.6 11/2011 61.2 12/2011 63.7
Date Format	MM/yyyy
Time Period	Month
Content Orientation	vertical
Range Axis Lower Bound	0
Show Legend	true

XY Line Chart

Parameters in Macro Browser		Data Table in Macro Placeholder	Rendered Chart
Type	xyLine	12 14 23 Revenue 41.1 31.8 12.4 Expense 31.1 41.8 43.6
Show Legend	true

XY Area Chart

Parameters in Macro Browser		Data Table in Macro Placeholder	Rendered Chart
Type	xyArea	12 14 23 Revenue 41.1 31.8 12.4 Expense 31.1 41.8 43.6
Show Legend	true

Area Charts

Example 1

Parameters in Macro Browser		Data Table in Macro Placeholder	Rendered Chart
Type	area	Satisfaction 2009 2010 2011 Very satisfied 20 23 34 Satisfied 40 34 23 Dissatisfied 25 26 25 Very dissatisfied 15 17 18
Show Legend	true
Width	300
Height	300
Opacity	50

Example 2

Parameters in Macro Browser		Data Table in Macro Placeholder	Rendered Chart
Type	area	Satisfaction 2009 2010 2011 Very satisfied 12 23 31 Satisfied 1 34 36 Dissatisfied 4 6 22 Very dissatisfied 2 7 12
Show Legend	true
Width	300
Height	300
Stacked Values	true

Gantt Chart

Parameters in Macro Browser		Data Table in Macro Placeholder	Rendered Chart
Type	gantt	Plan Start End Status Stage 1 6/25/2013 7/10/2013 30% Stage 2 7/13/2013 11/28/2013 40% Stage 3 12/1/2013 12/25/2013 Actual Start End Status Stage 1 6/25/2013 7/26/2013  100% Stage 2 7/29/2013 12/01/2013 40% Stage 3 12/10/2013 12/25/2013
Width	300
Height	200
Columns	,,1,2,3,4
Date format	MM/dd/yyyy

Code examples

Macro name: chart

Macro body: Accepts rich text, consisting of tables that hold the chart's data.

This macro recognizes a large number of parameters, listed here by type for convenience.

Chart type parameters

These parameters determine the type of chart to display and how the chart looks.

Chart display parameters

Chart title and label parameters

Chart data parameters

The data for the chart is taken from tables found in the macro body. The parameters below control how this data is interpreted. By default, numeric and date values are interpreted according to the Confluence global default language (locale) formats. If conversion fails, other languages defined in Confluence will be tried. You can specify additional conversion options using the parameters below.

Chart color parameters

Colors are specified using hexadecimal notation or HTML color names.

Chart axis parameters

Depending on the chart type, the range and domain axis may be customized. These values are automatically generated based on the data but can be overridden by specifying one or more more of these parameters.

Pie chart Parameters

%0% = %1%

%0% (%2%)

Chart attachment parameters

These are advanced options that can be used for chart versioning, to enable automation and to improve performance. Use these options carefully! Normally, the chart image is regenerated each time the page is displayed. These options allow for the generated image to be saved as an attachment and have subsequent access to re-use the attachment. This can be useful especially when combined with the Cache plugin to improve performance. Depending on the options chosen, chart images can be versioned for historical purposes.

Wiki markup example

Below is a simple example of a pie chart.

{chart:type=pie|title=Fish Sold}
|| Fish Type || 2004 || 2005 ||
|| Herring | 9,500 | 8,300 |
|| Salmon | 2,900 | 4,200 |
|| Tuna | 1,500 | 1,500 |
{chart}