Template:Data bars/doc

From Fanlore
Jump to navigation Jump to search

Usage

This is a template for displaying a bar chart.

Simple example in the default style:<syntaxhighlight lang="wikitext">

</syntaxhighlight>

Same thing, but horizontal (style=2):<syntaxhighlight lang="wikitext">

</syntaxhighlight>


Given multiple data rows that look like this:
Max. data columns: 16

<syntaxhighlight lang="wikitext">

</syntaxhighlight>

Max. data rows: 8
...the template displays a complex, color-keyed chart that looks like this:

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">

</syntaxhighlight>

title = Large numbers, small scale
scale = 0.1        style = 2
source = Data invented for this example.

<syntaxhighlight lang="wikitext">

</syntaxhighlight>

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

<syntaxhighlight lang="wikitext">

</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">

</syntaxhighlight>

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

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.