Template:Graph:Stacked/doc

This is a documentation subpage for Template:Graph:Stacked.
It may contain usage information, categories and other content that is not part of the original template page.

This graph's main version resides at mw:Template:Graph:Stacked. Please make or suggest all the changes there, and copy it everywhere else (until the copying is automated)

{{Graph:Stacked
| table=Bea.gov/GDP by state.tab
| type=year | xField=year | barwidth=14
| series="TX","NY","CA"
| title=Per state GDP
| chartSizing=fit
}}

{{Graph:Stacked
| table=Bea.gov/GDP by state.tab
| type=year | xField=year | legend=States
| series="TX","NY","CA"
| title=Per state GDP
| chartSizing=fit
}}

Per state GDP. See or edit source data.

{{Graph:Stacked | tabletype=query | table=
 SELECT ?decade (COUNT(?decade) AS ?count) WHERE {
  ?item wdt:P31 wd:Q3305213 .
  ?item wdt:P571 ?inception .
  BIND( year(?inception) as ?year ) .
  BIND( ROUND(?year/10)*10 as ?decade ) .
  FILTER( ?year > 1400)
 } GROUP BY ?decade ORDER BY ?decade
| series="count" | type=year | xField=decade
| title=Paintings by decade
}}

{{Graph:Stacked | tabletype=query | table=
 SELECT   ?year  (COUNT(?_genre) AS ?count ) (SAMPLE(?_genreLabel) AS ?label ) WHERE {
   ?item wdt:P31 wd:Q11424.
   ?item wdt:P577 ?_publication_date.
   ?item wdt:P136 ?_genre.
   ?_genre rdfs:label ?_genreLabel.
   BIND(str(YEAR(?_publication_date)) AS ?year)
   FILTER((LANG(?_genreLabel)) = "en")
   FILTER (?_publication_date >= "2000-00-00T00:00:00Z"^^xsd:dateTime)
 } 
 GROUP BY ?_genreLabel ?year
 HAVING (?count > 30)
| type=year | xField=year | group=label | value=count | legend=- 
| title=Number of films by year and genre
| xGrid=y | yGrid=y | colors="category20" | height=460 | barwidth=16
}}

Paintings by decade. See Wikidata query.

Number of films by year and genre. See Wikidata query.

Other examples available at testcases page: Template:Graph:Stacked/testcases.

This graph draws one or more independent numeric data series as either bar or area slices, stacked one on top of the other. The data must be stored on Commons' Data namespace or come from Wikidata Query Service.

Template parameters
Parameter		Description	Type	Status
Table type	`tabletype`	Specifies the type of the table data. "tab" (default) uses data namespace on commons, without the data: prefix. "query" sends request to wikidata query service. Default tab	String	optional
Table	`table`	Data page name on Commons, without the Data: prefix. The table should contain xField column, like year or date, and one or more series columns to plot. If tabletype parameter is set to "query", this value is the query	String	required
X axis type	`type`	Type of the x axis - time (e.g. "2015-10" or "2013-03-08), year (integer, but treated as a year), linear (numbers), ordinal (anything) Default year	String	suggested
X field	`xField`	Id of the data column that contains values for the X axis. If type=year, xField is also "year" by default.	String	required
Series	`series`	If each slice is represented by a separate column of data (or if there is only one column), list of the data columns to show as lines. Must be in quotes, and listed by field IDs if coming from a .tab page: "field1", "field2", "field3".	String	optional
Group	`group`	If slice color depends on just one column, specify that column's ID, instead of the series parameter.	String	optional
Value	`value`	If slice color depends on one column, this parameter should be set to the column which has the values	String	optional
Filter	`filter`	Optionally filter data with an template expression parameter e.g. `filter = datum.some_dataset_field > 1900 && datum.some_dataset_field < 2000` where `some_dataset_field` means some valid field of displayed dataset	String	optional
Bar width	`barwidth`	If set, show graph with bars instead of areas. If set, must be either an integer pixel width of the bars, or when type=ordinal, can also be set to 'auto'	String	optional
X axis starts at 0	`xZero, xAxisZero`	Force to start or not to start X axis with zero. Can be either true or false	String	optional
Y axis zero starts at 0	`yZero, yAxisZero`	Force to start or not to start Y axis with zero. Can be either true or false	String	optional
X axis scale clamp	`xAxisClamp`	no description	Boolean	optional
Y axis scale clamp	`yAxisClamp`	no description	Boolean	optional
X axis minimum	`xMin, xAxisMin`	Force X axis to start from this value	Unknown	optional
X axis maximum	`xMax, xAxisMax`	Force X axis to end with this value	Unknown	optional
Y axis minimum	`yMin, yAxisMin`	Force Y axis to start from this value	Unknown	optional
Y axis maximum	`yMax, yAxisMin`	Force Y axis to end with this value	Unknown	optional
Title	`title`	Title of the whole graph	String	optional
Title horizontal alignment	`titleXAlign`	Horizontal alignment of title, could be one of: left, center, right	String	optional
Title horizontal offset	`titleXOffset`	Horizontal offset of title position, could be negative, to shift title to the left, or positive to shift title to the right	Number	optional
X axis title	`xAxis, xAxisTitle`	Title of the X axis	String	optional
Y axis title	`yAxis, yAxisTitle`	Title of the Y axis	String	optional
X axis labels angle	`xAxisAngle`	Rotates the x axis labels by the specified angle. Recommended values are: -45, +45, -90, +90.	Number	optional
Y axis labels angle	`yAxisAngle`	Rotates the y axis labels by the specified angle.	Number	optional
X axis labels font size	`xAxisFontSize`	no description	Number	optional
Y axis labels font size	`yAxisFontSize`	no description	Number	optional
X axis grid	`xGrid`	Show grid lines for X axis	Boolean	optional
Y axis grid	`yGrid`	Show grid lines for Y axis	Boolean	optional
X axis ticks	`xTicks, xAxisTicks`	How many ticks to show on X axis. 7 by default. '-' value makes it automatic.	Number	optional
Y axis ticks	`yTicks, yAxisTicks`	How many ticks to show on Y axis. Auto '-' by default.	Number	optional
Raw vertical annotation values	`vAnnotationsValues`	Supply all annotation values as a list of JSON objects: {"text": "Big event", "x": 1980}, ...	String	optional
Raw horizontal annotation values	`hAnnotationsValues`	Supply all horizontal annotation values as a list of JSON objects: {"text":"Big event", "y": 980}, ...	String	optional
Vertical annotation table	`vAnnotationsTable`	Data page name on Commons, without the Data: prefix. The table must contain "x" column, and optional "text" and "color" columns.	String	optional
Horizontal annotation table	`hAnnotationsTable`	Data page name on Commons, without the Data: prefix. The table must contain "y" column, and optional "text" and "color" columns.	String	optional
Vertical annotation data transforms	`vAnnotationsTransforms`	no description	String	optional
Horizontal annotation data transforms	`hAnnotationsTransforms`	no description	String	optional
Legend	`legend`	Title of the legend	String	optional
Width	`width`	no description	Number	optional
Height	`height`	no description	Number	optional
Chart sizing mode	`chartSizing`	Chart sizing mode, could be one of: fit, pad. Vega default mode is `pad`. Use `fit` to force resulting chart canvas sizes to be exactly equal to provided width and height values. Use `pad` (or omit this parameter at all) to define prefered plotting size with provided width and height values, and let Vega increase overall chart size to include legend and title (if any)	String	optional
Colors	`colors`	The colors of the areas or bars, specified as Vega defined rangeliteral. This can also be a list like colors = [ "red", "green" ] or simply colors = red, green Default "category10"	String	optional
debug	`debug`	if set, will show graph as raw JSON	String	optional

Edit parameter translations

Wikipedia-specific options added to this template:

Parameter		Description	Type	Status
Thumbnail	`thumb`, `1`	If set, will style the chart with a border that matches that used for image thumbnails	Boolean	optional
Location	`align`, `2`	Implements the `left`, `right`, `center`, and `none` alignment options as described at image thumbnails. Defaults to `right` if `\|thumb=true`, otherwise defaults to `none`	String	optional
Caption	`caption`, `3`	Adds a caption under the image. if `\|hideSource=true`, it should include a link to the source data. Otherwise, make sure to end the caption with a period so it will display correctly with the source data after it.	String	optional
Hide source text	`hideSource`	If set, hides the "See or edit source data" text under the chart. If set, make sure to include a link to the source data elsewhere (such as in the caption).	Boolean	optional

Template calls can use the parameters by name, or they can be formatted similarly to normal image syntax. For example:

{{Graph:Stacked | thumb=true | align=left 
| caption=Per state GDP (via [[:Commons:Data:Bea.gov/GDP by state.tab]])
| table=Bea.gov/GDP by state.tab
| type=year | xField=year | barwidth=14
| series="TX","NY","CA"
| chartSizing=fit
| hideSource=true
}}

{{Graph:Stacked | thumb | center | Per state GDP.
| table=Bea.gov/GDP by state.tab
| type=year | xField=year | legend=States
| series="TX","NY","CA"
| title=Per state GDP
| chartSizing=fit
}}

Per state GDP (via Commons:Data:Bea.gov/GDP by state.tab)

Per state GDP. See or edit source data.