Module:Chart/doc: Difference between revisions

Revision as of 09:43, 5 January 2014

Latest revision as of 20:03, 24 May 2025

(28 intermediate revisions by 15 users not shown)

Line 1:

{{high-use|850}}

{{Template display|badmobile}}

Module Chart exports two functions: bar chart and pie chart

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 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 "tuple" as explained above, but without the parenthesis:

<pre>

| slice 1 = Value1 : Name1 : Color1 : Link1

Line 257 ⟶ 242:

===Examples===

<pre>

{{#invoke:Chart|pie chart

Line 269 ⟶ 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 288 ⟶ 268:

| percent = true

}}

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

<pre>

Line 357 ⟶ 334:

| percent = true

}}

<noinclude>

[[Category:Module documentation pages]]

</noinclude>