Template:Graph:PieChart/doc

From IxWiki
Jump to navigation Jump to search

Pie charts

You can add a pie chart with a call to this template. This template uses the Vega version 2 JSON specification. An older template {{Pie chart}} is based on CSS rendering. The template GraphChart allows adding of map, line, bar and area charts, as well as stacked line, stacked bar and stacked area charts, but no pie charts. The template GraphChart also uses Vega version 2 and uses Module:Graph with Scribunto/Lua programming. This Template:Graph:PieChart doesn't use Lua.

Parameters

  • radius specifies the radius of the pie chart in pixels, default is 100
  • legend specifies the title to be displayed above the legend, default is "Legend". To hide legend, set it to a "-" value without quotes.
  • values this is a list between square brackets of comma separated label value pairs between single curly braces like [ {"x": "Peaches","y": 100}, {"x": "Plums","y": 32}]
  • rangeliteral this can be one of the Vega specified rangeliterals, default is "category10", but can also be a list like ["red", "green"]

Examples

Example usage:

{{Graph:PieChart|legend=Fruits|radius=125|values= [
      {"x": "Peaches","y": 100},
      {"x": "Plums","y": 32},
      {"x": "Blueberries","y": 80},
      {"x": "Strawberries","y": 46},
      {"x": "Bananas","y": 41}
    ] 
}}

<graph> {

 "version": 2,
 "height": 100,
 "width": 100,

"legends": [{"title": "Fruits","fill": "color"}],

 "padding": "auto",
 "marks": [
   {
     "properties": {
       "enter": {
         "innerRadius": {"value": 0 },
         "stroke": {"value": "white"},
         "startAngle": {"field": "layout_start"},
         "outerRadius": {"value": 100 },
         "endAngle": {"field": "layout_end"},
         "fill": {"field": "x","scale": "color"},
       }
     },
     "from": {
       "data": "table",
       "transform": [{"field": "y","type": "pie"}]
     },
     "type": "arc"
   }
 ],
 "data": [
   {
     "name": "table", "values": [
     {"x": "Peaches","y": 100},
     {"x": "Plums","y": 32},
     {"x": "Blueberries","y": 80},
     {"x": "Strawberries","y": 46},
     {"x": "Bananas","y": 41}
   ]
   }
 ],
 "scales": [
   {
     "name": "color",
     "range": "category10",
     "domain": {"data": "table","field": "x"},
     "type": "ordinal"
   }
 ]

} </graph>

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Graph:PieChart in articles based on its TemplateData.

TemplateData for Graph:PieChart

This template adds a pie chart to the page using Graph extension

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Radiusradius

Specify the radius of the pie in number of pixels

Default
100
Example
100
Numbersuggested
Legend Titlelegend

The title that will appear above the legend, or '-' to hide it

Default
"Legend"
Example
"Fruits"
Stringsuggested
Inner Radiusinnerradius

To create a doughnut chart specify an inner radius

Default
0
Example
0
Numberoptional
Valuesvalues data

Specify the label value pairs

Example
[ {"x": "Peaches","y": 100}, {"x": "Plums","y": 32}, {"x": "Blueberries","y": 80}, {"x": "Strawberries","y": 46}, {"x": "Bananas","y": 41} ]
Unknownrequired
The colors of the slicesrangeliteral colors

The colors of the slices, specified as Vega defined rangeliteral. This can also be a list like [ "red", "green" ]

Default
"category10"
Example
"category10"
Stringoptional