# Module:Chart/doc

Module Chart exports two functions: bar chart and pie chart  

## Drawing Bar charts: "bar chart"

### Parameters

| 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. |
| 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. |
| 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. |  |
| 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. |  |
| used in tooltip. e.g., $, so values will show as "$500" instead of "500" in the tooltip |  |
| 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. |  |
| names of different groups | } |

### Examples

#### Basic
<pre>  

</pre>  

#### Stacked
Here is the same graph, with more modest height and width, using "stack", and adding "units suffix" for good measure:  

<pre>  

</pre>  

#### Scale per group
It is possible to show each of the groups using different scale and units:  

<pre>  

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

<pre>  

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

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

<pre>  

</pre>  

## Drawing Pie charts: "pie chart"

### Parameters

| 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** | Tuples, in parenthesis. Use delimiter inside the tuple:
( 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: |  |  |
| alternative syntax to "slices". 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 | slice 2 = Value2 : Name2 : Color2 : Link2 | ...
</pre>
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. |  |  |
| **** | used in the legend. e.g., defining "units prefix=$", values will show as "$500" instead of "500" in the legends |  |  |
| **** | 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. |  |  |
| **** | 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>  

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>  

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

<pre>  

</pre>