Module:Bar box/doc

This 'Bar box' template documentation is transcluded for all Bar box/doc including templates [edit]. 

{{bar box}}, {{bar percent}} and {{bar pixel}} are a family of templates for construction of horizontal bar charts.

Usage

{{Bar box
|width   =  width of the graph (optional)
|barwidth=  width of the bararea (optional, defaults to 100px)
|float   =  (left|right|none) (optional, defaults to none)
|title   =  title of the chart (optional)
|titlebar=  title bar colour (optional, defaults to none)
|left1   =  first left column header (optional)
|left2   =  second left column header (optional)
|right1  =  first right column header (optional)
|right2  =  second right column header (optional)
|bars    =  chart contents(see below)
|caption =  caption under the chart   (optional)}
}}

Chart contents

Bar box can contain any number of bars. There are two types of bars:

• Percentage bar:

{{bar percent|row label|colour|value (width in percents)|optional value label}}

If value label is not provided, it is constructed from the percentage and "%".

• Pixel bar:

{{bar pixel|row label|colour|value (width in pixels)|value suffix|optional value label}}

If value label is provided, value suffix is ignored. Otherwise, the value label is constructed from the value and the value suffix. This is used as shorthand. Both following examples give identical results:

{{bar pixel|foo|red|12||12,345}}
{{bar pixel|foo|red|12|3,45}}

Dømi

foo			30%
bar			40%
baz			20%
bla			8%
bla			1/50
distribution of stuff

{{bar box
|float=right
|caption=distribution of stuff
|width=200px
|bars=
{{bar percent|foo|red|30}}
{{bar percent|bar|green|40}}
{{bar percent|baz|blue|20}}
{{bar percent|bla|orange|8}}
{{bar percent|bla|teal|2|1/50}}
}}

Quantity of stuff
kinds of stuff				pcs.
Foobar			33,213
Barfoo			123,123
Bazbar			210,121
Barfoobaz			12,854
Some stuff displayed by quantity.

{{bar box
|title=Quantity of stuff
|titlebar=#DDD
|left1=kinds of stuff
|right2=pcs.
|width=300px
|bars=
{{bar pixel|Foobar|red|33|,213}}
{{bar pixel|Barfoo|green|123|,123}}
{{bar pixel|Bazbar|blue|210|,121}}
{{bar pixel|Barfoobaz|orange|13||12,854}}
|caption=Some stuff displayed by quantity.
}}

Valúrslit
party	year		votes	change
Left	1898		33%	+9%
	1902		42%
Right	1898		40%	-5%
	1902		35%
Middle	1898		17%	-7%
	1902		10%
Other	1898		10%	+3%
	1902		13%
1902 and 1898 election results in Freedonia compared.

{{bar box
|float=right
|title=Valúrslit
|titlebar=#AAF
|left1=flokkur
|left2=ár
|right1=atkvøður
|right2=broyting
|width=300px
|bars=
{{bar percent 2|Left|1898|silver|33|1902|red|42|+9%}}
{{bar percent 2|Right|1898|silver|40|1902|black|35|-5%}}
{{bar percent 2|Middle|1898|silver|17|1902|blue|10|-7%}}
{{bar percent 2|Other|1898|silver|10|1902|gray|13|+3%}}
|caption=1902 and 1898 election results in Freedonia compared.
}}