Module:Chart/doc: Difference between revisions

Revision as of 21:16, 28 June 2013

Latest revision as of 20:03, 24 May 2025

(32 intermediate revisions by 16 users not shown)

Line 1:

{{high-use|850}}

{{Template display|badmobile}}

Module Chart exports two functions: bar chart and pie chart

Line 21 ⟶ 23:

|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

Line 29 ⟶ 31:

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

Line 38 ⟶ 40:

|-

| {{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===

Line 106 ⟶ 113:

====Scale per group====

It is possible to show each of the groups using different scale and units:

This option has been disabled. It was rarely used and broke in the last code update.

<pre>

Here is an example with large number of groups - mainly to test how does it looklooks with large number of legends.:

{{ #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

}}

</pre>

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.

{{ #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

}}

<pre>

{{ #invoke:Chart | bar chart

| width = 800

| height = 550

| group 1 = 1500000 : 2500000 : 3500000

| group 21 = 200 1: 5000 2: 450003:4:5:4:3:2:1

| group 32 = 2000 1: 5000 2: 200003:4:5:4:3:2:1

| group 3 = 1:2:3:4:5:4:3:2:1

| colors = red : blue : green

| group names4 = People 1: Cars 2: Average car cost3:4:5:4:3:2:1

| group 5 = 1:2:3:4:5:4:3:2:1

| x legends = 1920 : 1965 : 2002

| group 6 = 1:2:3:4:5:4:3:2:1

| tooltip 2 = : There is no good data for number of cars in 1965. we use 5,000 as best estimate

| unitsgroup prefix7 = 1: 2: $3:4:5:4:3:2:1

| group 8 = 1:2:3:4:5:4:3:2:1

| scale per group = 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 prefixsuffix = : : $_billion

| stack = 1

}}

</pre>

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.

{{ #invoke:Chart | bar chart

Line 190 ⟶ 176:

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

| stack = 1

}}

Line 199 ⟶ 185:

If there are many values, x legends can be diluted by using delimiters with nothing in between:

<pre>

Line 233 ⟶ 218:

|'''radius''' ||number. The radius of the pie in pixels

|-

|'''slices''' || TupplesTuples, in parenthesis. Use delimiter inside the tuppletuple:

( 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.

Line 239 ⟶ 224:

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: <nowiki>[[Article|Tooltip]] for internal link, [[#Paragraph name|Tooltip]] for linking to an anchor in same article, or [http://example.org Tooltip] for external link.</nowiki>

|-

|{{nowrap|'''slice n'''}}|| alternative syntax to "alicesslices". 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 "tuppletuple" as explained above, but without the parenthesis:

<pre>

| slice 1 = Value1 : Name1 : Color1 : Link1

Line 247 ⟶ 232:

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.

|-

|;'''{{nowrap|units prefix}}''' || used in the legend. e.g., defining "units prefix=$", values will show as "$500" instead of "500" in the legends

|-

|;'''{{nowrap|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.

|-

|'''{{nowrap|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===

<pre>

{{#invoke:Chart|pie chart

Line 267 ⟶ 255:

| percent = true

}}

</pre>

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).

</pre>

{{#invoke:Chart|pie chart

| radius = 150

Line 286 ⟶ 268:

| percent = true

}}

An example for the alternative syntax with "slice 1", "slice 2" etc.

<pre>

Line 355 ⟶ 334:

| percent = true

}}

<noinclude>

[[Category:Module documentation pages]]

</noinclude>