Template:Data bars

Template documentation[view] [edit] [history] [purge]

Usage

This is a template for displaying a bar chart.

Simple example in the default style:<syntaxhighlight lang="wikitext"> Berries 65 38 72 47 20 30 Jan Feb Mar Apr May Jun Total: 272 </syntaxhighlight>	Berries 65 38 72 47 20 30 Jan Feb Mar Apr May Jun Total: 272
Same thing, but horizontal (style=2):<syntaxhighlight lang="wikitext"> Berries Jan 65 Feb 38 Mar 72 Apr 47 May 20 Jun 30 Total: 272 </syntaxhighlight>	Berries Jan 65 Feb 38 Mar 72 Apr 47 May 20 Jun 30 Total: 272

Given multiple data rows that look like this:
↔ Max. data columns: 16 ↔
<syntaxhighlight lang="wikitext"> 200 190 260 200 210 170 200 260 230 200 180 210 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec Total: 2510 Apples Bananas Oranges </syntaxhighlight>	↕ Max. data rows: 8 ↕
...the template displays a complex, color-keyed chart that looks like this: 200 190 260 200 210 170 200 260 230 200 180 210 Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec Total: 2510 Apples Bananas Oranges

Title, Scale, Source and Alignment

Optional named parameters include title, scale and source.

A title appears bolded and centered above the chart.

A scale is needed for handling very small or large numbers.

A source tells the viewer where the data came from.

title = Small numbers, large scale scale = 10 source = Data invented for this example. <syntaxhighlight lang="wikitext"> Small numbers, large scale 20 19 26 20 21 17 Jan Feb Mar Apr May Jun Total: 123 Cherries Berries Grapes Source: Data invented for this example. </syntaxhighlight> Small numbers, large scale 20 19 26 20 21 17 Jan Feb Mar Apr May Jun Total: 123 Cherries Berries Grapes Source: Data invented for this example.

title = Large numbers, small scale scale = 0.1        style = 2 source = Data invented for this example. <syntaxhighlight lang="wikitext"> Large numbers, small scale Jul 2000 Aug 1900 Sep 2600 Oct 2000 Nov 2100 Dec 1700 Total: 12300 Apples Bananas Oranges Source: Data invented for this example. </syntaxhighlight> Large numbers, small scale Jul 2000 Aug 1900 Sep 2600 Oct 2000 Nov 2100 Dec 1700 Total: 12300 Apples Bananas Oranges Source: Data invented for this example.

Also, to center or to float a chart left or right, specify center, right or left in parameter align (aka float). For example:

Berries
65 38 72 47 20 30 Jan Feb Mar Apr May Jun	Total: 272

<syntaxhighlight lang="wikitext"> Berries 65 38 72 47 20 30 Jan Feb Mar Apr May Jun Total: 272 </syntaxhighlight>

Orientation, Borders, Details and Averages

There are sixteen styles to choose from.

Odd numbered styles are vertical.

Even numbered styles are horizontal.

Styles 3 and 4 have borders and shading.

Styles 5 thru 8 are the same as 1 thru 4, but show additional detail.

Styles 9 thru 16 are the same as 1 thru 8, but averages are displayed with the color key, instead of totals.

For example, here's one using style=8:

Horizontal, with borders, shading and visible detail.

<syntaxhighlight lang="wikitext"> Fruit Amounts (lbs) 2009 300 700 500 900 2400 2010 500 300 400 700 1900 2011 600 600 1100 900 3200 2012 900 1100 600 300 2900 2013 700 900 900 700 500 3700 2014 600 600 800 300 2300 Total: 16400 Apples (2700) Bananas (4100) Oranges (3500) Cherries (3100) Berries (3000) Source: Data invented for this example. </syntaxhighlight>

Fruit Amounts (lbs) 2009 300 700 500 900 2400 2010 500 300 400 700 1900 2011 600 600 1100 900 3200 2012 900 1100 600 300 2900 2013 700 900 900 700 500 3700 2014 600 600 800 300 2300 Total: 16400 Apples (2700) Bananas (4100) Oranges (3500) Cherries (3100) Berries (3000) Source: Data invented for this example.

And here's exactly the same data in style=13, showing averages on the right instead of totals:

Fruit Amounts (lbs) 2400   900 500 700 300 1900   700 400 300 500 3200   900 1100 600 600 2900   300 600 1100 900 3700   500 700 900 900 700 2300   300 800 600 600 2009 2010 2011 2012 2013 2014 2733.33   Apples (450) Bananas (683.33) Oranges (583.33) Cherries (516.67) Berries (500) Average Source: Data invented for this example.

Method

This template employs five "sub-templates." A table is created using the columns and rows of data.

{{Data bars/bar}} draws each vertical or horizontal rectangle optionally colored and labeled with a name and/or a value.

{{Data bars/column}} handles one column of data.

If style is > 8, the data is passed along to other sub-templates to display averages instead of totals with the color key.

{{Data bars/averages}} calculates the averages of all the rows of data.

{{Data bars/averages/display}} assigns the averages to named parameters for display as a single complex bar.

{{Data bars/averages/column}} draws a vertical labeled bar of averages serving as a color key.

The above documentation is transcluded from Template:Data bars/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.