Module:Chart/doc
This is the documentation page for Module:Chart
Module Chart exports two functions: bar chart and pie chart
Drawing Bar charts: "bar chart"
[edit]Parameters
[edit]| parameter name | what it does |
|---|---|
| delimiter | string to delimit multiple values when given. default to colon ( : ). normally you do not want to touch this, it's provided for the off-chance you'll want to use colon as part of one of the parameters. |
| width | number. if provided, must be at least 200. default: 500 |
| height | number. if provided, must be at least 200. default: 350 |
| group n | (where "n" is a number. use "group 1", "group 2" etc. for as many groups as there are in the graph) the values to be charted. see below. |
| tooltip n | tooltip to be associated with specific bar. If no tooltip for a specific bar is defined, and this bar has a link, then this link will be used as tooltip. Otherwise, the tooltip will be combined from the group name and the value, optionally with "units prefix" and "units suffix". |
| links n | links to articles to be associated with specific bar |
| stack | whether to stack the different groups on top of each other. do not specify to show bars side by side. Any non-empty value means "yes". To say "no", simply do not supply this parameter at all, or leave the value blank. |
| tooltip value accumulation | useful only with stack: when set to true, tooltip will show accumulated value of all blocks up to current one |
| colors | the colors used to denote the various groups. should have exactly as many values as # of groups. can be given as standard html-recognized color names, or using #xxx or #xxxxxx notation. |
| x legends | The legends for the X values. Wikicode, such as internal links or templates can be used. |
| hide group legends | if set to true, group legends will not be shown below chart. Any non-empty value means "yes". To say "no", simply do not supply this parameter at all, or leave the value blank. |
| scale per group | set to use separate Y- scale for each group. leave empty to use one scale for all groups. incompatible with "stack". Note that even if some of the scales are exactly the same, they will be drawn separately when this setting is on. Any non-empty value means "yes". To say "no", simply do not supply this parameter at all, or leave the value blank. |
| units prefix | used in tooltip. e.g., $, so values will show as "$500" instead of "500" in the tooltip |
| units suffix | ditto for units suffix. use, e.g. "Kg" so values will show as 88Kg instead of 88 in tooltip. underscore ("_") are replaced by spaces, to allow a space between the value and the suffix. |
| group names | names of different groups |
Examples
[edit]Basic
[edit]{{ #invoke:Chart | bar chart
| group 1 = 40 : 50 : 60 : 20
| group 2 = 20 : 60 : 12 : 44
| group 3 = 55 : 14 : 33 : 5
| links 1 = Apple : McCintosh : Golden delicious
| links 2 = Banana : Apricot : Peach
| links 3 = Orange : Pear : Bear
| tooltip 2 = tooltip 1 : tooltip 2 : tooltip 3 : tooltip 4
| colors = green : yellow : orange
| group names = Apple : Banana : Orange
| x legends = Before : During : After : Post mortem
}}
10
20
30
40
50
60
70
Before
During
After
Post mortem
- Apple
- Banana
- Orange
Stacked
[edit]Here is the same graph, with more modest height and width, using "stack", and adding "units suffix" for good measure:
{{ #invoke:Chart | bar chart
| height = 250
| width = 300
| stack = 1
| group 1 = 40 : 50 : 60 : 20
| group 2 = 20 : 60 : 12 : 44
| group 3 = 55 : 14 : 33 : 5
| colors = green : yellow : orange
| group names = Apple : Banana : Orange
| units suffix = Kg
| x legends = Before : During : After : Post mortem
}}
25
50
75
100
125
150
Before
During
After
Post mortem
- Apple
- Banana
- Orange
Scale per group
[edit]It is possible to show each of the groups using different scale and units:
{{ #invoke:Chart | bar chart
| width = 800
| group 1 = 1500000 : 2500000 : 3500000
| group 2 = 200 : 5000 : 45000
| group 3 = 2000 : 5000 : 20000
| colors = red : blue : green
| group names = People : Cars : Average car cost
| x legends = 1920 : 1965 : 2002
| tooltip 2 = : There is no good data for number of cars in 1965. we use 5,000 as best estimate
| units prefix = : : $
| scale per group = 1
}}
Notice the "units prefix" field: we do not need prefix for the first 2 groups, so we use colons with no content. we could write "::$" instead of " : : $".
Also note the special tooltip for the "Cars" number for 1965.
1,000,000
2,000,000
3,000,000
4,000,000
10,000
20,000
30,000
40,000
50,000
5,000
10,000
15,000
20,000
25,000
30,000
1920
1965
2002
- People
- Cars
- Average car cost
{{ #invoke:Chart | bar chart
| width = 800
| group 1 = 1500000 : 2500000 : 3500000
| group 2 = 200 : 5000 : 45000
| group 3 = 2000 : 5000 : 20000
| colors = red : blue : green
| group names = People : Cars : Average car cost
| x legends = 1920 : 1965 : 2002
| tooltip 2 = : There is no good data for number of cars in 1965. we use 5,000 as best estimate
| units prefix = : : $
| scale per group = 1
}}
Notice the "units prefix" field: we do not need prefix for the first 2 groups, so we use colons with no content. we could write "::$" instead of " : : $".
Also note the special tooltip for the "Cars" number for 1965.
Here is an example with large number of groups - mainly to test how does it look with large number of legends.
25
50
75
100
125
150
1920
1930
1940
1950
1960
1970
1990
2000
2010
- Alabama
- Alaska
- Arizona
- Arkansas
- California
- Colorado
- Connecticut
- Delaware
- Florida
- Georgia
- Hawaii
- Idaho
- Illinois
- Indiana
- Iowa
- Kansas
- Kentucky
- Louisiana
- Maine
- Maryland
- Massachusetts
If there are many values, x legends can be diluted by using delimiters with nothing in between:
{{ #invoke:Chart | bar chart
| group 1 = 1:2:3:4:5:6:7:8:9:10:11:12:13:14:15:16:17:18:19:20:21:22:23:24:25:26:27:28:29:30
:31:32:33:34:35:36:37:38:39:40:41:42:43:44:45:46:47:48:49:50:51:52:53:54:55:56:57:58:59
| units suffix = _Things
| group names = Some
| x legends = ::::1940::::::::::1950::::::::::1960::::::::::1970::::::::::1980::::::::::1990::::
}}
10
20
30
40
50
60
1940
1950
1960
1970
1980
1990
Drawing Pie charts: "pie chart"
[edit]Parameters
[edit]| parameter name | what it does |
|---|---|
| delimiter | string to delimit multiple values when given. default to colon ( : ). normally you do not want to touch this, it's provided for the off-chance you'll want to use colon as part of one of the parameters. |
| radius | number. The radius of the pie in pixels |
| slices | Tupples, in parenthesis. Use delimiter inside the tupple:
( Value1 : Name1 : Color1 : Link1 ) ( Value2 : Name2 : Color2 : Link2 ) ... The values are numbers. The numbers can be integers or decimal fractions, or using the scientific notation: 7.24e6, 7,240,000, or 7240000.00 are all acceptable for 7 Million and 240 thousands. Names are strings. Colors are optional. you can use any Web colors, such as "red" or "#FF0000". Up to 26 default colors are defined, but if your pie has more than 26 slices, you must define the colors of slice #27 and up. Links can be external or internal links, including linking to internal anchors and paragraphs in the same article, like so: [[Article|Tooltip]] for internal link, [[#Paragraph name|Tooltip]] for linking to an anchor in same article, or [http://example.org Tooltip] for external link. |
| slice n | alternative syntax to "alices". n is the slice number, beginning with 1. make sure not to skip: if you define "slice 1", "slice 2", "slice 4", "slice 5"..., skipping slice 3, only the first two slices will be shown. this syntax is incompatible with "slices", i.e., they should not be used in conjunction in the same invocation. Using both "slices" and "slice n" in the same invocation will cause unpredictable results. The value is like a single "tupple" as explained above, but without the parenthesis:
| slice 1 = Value1 : Name1 : Color1 : Link1 | slice 2 = Value2 : Name2 : Color2 : Link2 | ... This syntax allows you to use parenthesis in names, links, and colors. |
| percent | if used, the percentage of each slice will be calculated and added to the legend: so if you have two slices, like so: ( 1 : Younglings ) ( 3 : elders ), and use define "percent", the legends will become "Younglings: 1 (25%)" and "Elders: 3 (75%)", instead of simply "Younglings: 1" and "Elders: 3". Any non-empty value means "yes". To say "no", simply do not supply this parameter at all, or leave the value blank. |
| units prefix | used in the legend. e.g., defining "units prefix=$", values will show as "$500" instead of "500" in the legends |
| units suffix | ditto for units suffix. use, e.g. "Kg" so values will show as 88Kg instead of 88 in legend. underscore ("_") are replaced by spaces, to allow a space between the value and the suffix. |
| hide group legends | Setting to true prevents displaying of the group legends under the chart. Any non-empty value means "yes". To say "no", simply do not supply this parameter at all, or leave the value blank. |
Examples
[edit]{{#invoke:Chart|pie chart
| radius = 150
| slices =
( 1000000 : Apples )
( 2000000 : Bananas : gold)
( 1440000 : Apricots )
( 6.4e5 : Pears : : [[Pear|Pears]] )
( 750,000 : Pineapples )
| units suffix = _Tonne
| percent = true
}}
Note that we can leave the color empty to use the default, but in order to add the link to "Pear",
we had to mark the parameter by adding an extra delimiter to mark the omitted color parameter
Also note that the values can be provided with "language specific" format (like 1,000),
or scientific notation like 6.4e5. In the legends, numbers will always be displayed in
language-adjusted mode (can look different if module imported to other wikis).
- Apples: 1,000,000 Tonne (17.2%)
- Bananas: 2,000,000 Tonne (34.3%)
- Apricots: 1,440,000 Tonne (24.7%)
- Pears: 640,000 Tonne (11.0%)
- Pineapples: 750,000 Tonne (12.9%)
An example for the alternative syntax with "slice 1", "slice 2" etc.
{{#invoke:chart|pie chart
|radius= 200
|units suffix = _Units
| slice 1 = 1 : 1
| slice 2 = 7 : 7
| slice 3 = 8 : 8
| slice 4 = 9 : 9
| slice 5 = 10 : 10
| slice 6 = 11 : 11
| slice 7 = 12 : 12
| slice 8 = 13 : 13
| slice 9 = 14 : 14
| slice 10 = 15 : 15
| slice 11 = 16 : 16
| slice 12 = 17 : 17
| slice 13 = 18 : 18
| slice 14 = 19 : 19
| slice 15 = 20 : 20
| slice 16 = 21 : 21
| slice 17 = 22 : 22
| slice 18 = 23 : 23
| slice 19 = 24 : 24
| slice 20 = 25 : 25
| slice 21 = 26 : 26
| slice 22 = 27 : 27
| slice 23 = 28 : 28
| slice 24 = 29 : 29
| slice 25 = 30 : 30
| slice 26 = 31 : 31
| percent = true
}}
- 1: 1 Units (0.2%)
- 7: 7 Units (1.5%)
- 8: 8 Units (1.7%)
- 9: 9 Units (1.9%)
- 10: 10 Units (2.1%)
- 11: 11 Units (2.3%)
- 12: 12 Units (2.5%)
- 13: 13 Units (2.7%)
- 14: 14 Units (2.9%)
- 15: 15 Units (3.2%)
- 16: 16 Units (3.4%)
- 17: 17 Units (3.6%)
- 18: 18 Units (3.8%)
- 19: 19 Units (4.0%)
- 20: 20 Units (4.2%)
- 21: 21 Units (4.4%)
- 22: 22 Units (4.6%)
- 23: 23 Units (4.8%)
- 24: 24 Units (5.0%)
- 25: 25 Units (5.3%)
- 26: 26 Units (5.5%)
- 27: 27 Units (5.7%)
- 28: 28 Units (5.9%)
- 29: 29 Units (6.1%)
- 30: 30 Units (6.3%)
- 31: 31 Units (6.5%)