@@ Line 1: / Line 1: @@
 <includeonly>
-{{Module:Chart/doc}}
+{{Template display|badmobile}}
+Module Chart exports two functions: bar chart and pie chart. We will '''not''' be using the pie chart function. The invocation doesn't display properly and we have other alternatives. For the sake of following through I'll remove the descriptive syntax for that section and consider a reductive refactor. A simpler Chart generator would be much preferable when there are perfectly functional options, see:
+*[[Module:Piechart]]
+*[[Template:Piechart]]
+*[[Template:Pie chart]]
+; Note - [[Template:Graph:Chart]] is a '''broken''' template on Wikipedia. I will recreate this module's invocation at [[Template:ChartMod]] with a few redirects specific to it. Currently, [[Template:Chart]] redirects to [[Template:Tree chart]]. I'm fine with this since the use of this module is technically sound (''Charts'' are not subject to the Graph extension situation, merely in proximity) and wouldn't necessarily default to a hacky module for generating results.
+==Drawing Bar charts: "bar chart"==
+===Parameters===
+{| class="wikitable"
+|-
+! 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.
+|-
+|{{nowrap|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.
+|-
+|{{nowrap|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.
+|-
+|{{Nowrap|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.
+|-
+|{{nowrap|units prefix}} || used in tooltip. e.g., $, so values will show as "$500" instead of "500" in the tooltip
+|-
+|{{nowrap|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.
+|-
+| {{nowrap|group names}} || names of different groups
+|-
+| {{nowrap|y tick marks}} || number of tick marks on the y axis.  if the value is negative or omitted, the module will attempt to automatically calculate a sensible number of tick marks.
+|}
+==Display in the mobile view==
+Bar charts behave unpredictably, causing problems with the axes and legend. Use [[Template:Graph:Chart]] instead. {{dubious span |date=July 2023 |Pie charts aren't too bad.}}
+===Examples===
+==== Basic ====
+<pre>
+{{ #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
+}}
+</pre>
+{{ #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
+}}
+====Stacked====
+Here is the same graph, with more modest height and width, using "stack", and adding "units suffix" for good measure:
+<pre>
+{{ #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
+}}
+</pre>
+{{ #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
+| units suffix = Kg
+| group names = Apple : Banana : Orange
+| x legends = Before : During : After : Post mortem
+}}
+====Scale per group====
+This option has been disabled. It was rarely used and broke in the last code update.
+Here is an example with large number of groups - mainly to test how it looks with large number of legends:
+<pre>
+{{ #invoke:Chart | bar chart
+| width = 800
+| height = 550
+| group 1 = 1:2:3:4:5:4:3:2:1
+| group 2 = 1:2:3:4:5:4:3:2:1
+| group 3 = 1:2:3:4:5:4:3:2:1
+| group 4 = 1:2:3:4:5:4:3:2:1
+| group 5 = 1:2:3:4:5:4:3:2:1
+| group 6 = 1:2:3:4:5:4:3:2:1
+| group 7 = 1:2:3:4:5:4:3:2:1
+| group 8 = 1:2:3:4:5:4:3:2:1
+| group 9 = 1:2:3:4:5:4:3:2:1
+| group 10 = 1:2:3:4:5:4:3:2:1
+| group 11 = 1:2:3:4:5:4:3:2:1
+| group 12 = 1:2:3:4:5:4:3:2:1
+| group 13 = 1:2:3:4:5:4:3:2:1
+| group 14 = 1:2:3:4:5:4:3:2:1
+| group 15 = 1:2:3:4:5:4:3:2:1
+| group 16 = 1:2:3:4:5:4:3:2:1
+| group 17 = 1:2:3:4:5:4:3:2:1
+| group 18 = 1:2:3:4:5:4:3:2:1
+| group 19 = 1:2:3:4:5:4:3:2:1
+| group 20 = 1:2:3:4:5:4:3:2:1
+| group 21 = 1:2:3:4:5:4:3:2:1
+| colors = Silver:Gray:Black:Red:Maroon:Yellow:Olive:Lime:Green:Aqua:Teal:Blue:Navy:Fuchsia:Purple:ForestGreen:Tomato:LightSeaGreen:RosyBrown:DarkOliveGreen:MediumVioletRed
+| group names = Alabama:Alaska:Arizona:Arkansas:California:Colorado:Connecticut:Delaware:Florida:Georgia:Hawaii:Idaho:Illinois:Indiana:Iowa:Kansas:Kentucky:Louisiana:Maine:Maryland:Massachusetts
+| x legends = 1920 : 1930 : 1940: 1950 : 1960 : 1970 : 1990 : 2000 : 2010
+| units prefix = $
+| units suffix = _billion
+| stack = 1
+}}
+</pre>
+{{ #invoke:Chart | bar chart
+| width = 800
+| height = 550
+| group 1 = 1:2:3:4:5:4:3:2:1
+| group 2 = 1:2:3:4:5:4:3:2:1
+| group 3 = 1:2:3:4:5:4:3:2:1
+| group 4 = 1:2:3:4:5:4:3:2:1
+| group 5 = 1:2:3:4:5:4:3:2:1
+| group 6 = 1:2:3:4:5:4:3:2:1
+| group 7 = 1:2:3:4:5:4:3:2:1
+| group 8 = 1:2:3:4:5:4:3:2:1
+| group 9 = 1:2:3:4:5:4:3:2:1
+| group 10 = 1:2:3:4:5:4:3:2:1
+| group 11 = 1:2:3:4:5:4:3:2:1
+| group 12 = 1:2:3:4:5:4:3:2:1
+| group 13 = 1:2:3:4:5:4:3:2:1
+| group 14 = 1:2:3:4:5:4:3:2:1
+| group 15 = 1:2:3:4:5:4:3:2:1
+| group 16 = 1:2:3:4:5:4:3:2:1
+| group 17 = 1:2:3:4:5:4:3:2:1
+| group 18 = 1:2:3:4:5:4:3:2:1
+| group 19 = 1:2:3:4:5:4:3:2:1
+| group 20 = 1:2:3:4:5:4:3:2:1
+| group 21 = 1:2:3:4:5:4:3:2:1
+| colors = Silver:Gray:Black:Red:Maroon:Yellow:Olive:Lime:Green:Aqua:Teal:Blue:Navy:Fuchsia:Purple:ForestGreen:Tomato:LightSeaGreen:RosyBrown:DarkOliveGreen:MediumVioletRed
+| group names = Alabama:Alaska:Arizona:Arkansas:California:Colorado:Connecticut:Delaware:Florida:Georgia:Hawaii:Idaho:Illinois:Indiana:Iowa:Kansas:Kentucky:Louisiana:Maine:Maryland:Massachusetts
+| x legends = 1920 : 1930 : 1940: 1950 : 1960 : 1970 : 1990 : 2000 : 2010
+| units prefix = $
+| units suffix = _billion
+| stack = 1
+}}
+If there are many values, x legends can be diluted by using delimiters with nothing in between:
+<pre>
+{{ #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::::
+}}
+</pre>
+{{ #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:
+: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::::
+}}
+{{-}}
+== Pie Charts ==
+'''Have been ignored in favor of working alternatives. The pie chart invocation results in a corrupted output image. See the alternatives mentioned at the top of the page.'''
 [[Category:Module sandboxes]]
 [[Category:Module sand&test]]

Latest revision as of 21:37, 14 March 2025