Tɛmplet:ChartColorLegends/doc

This is a documentation subpage for Tɛmplet:ChartColorLegends.
It contains usage information, categories and other content that is not part of the original tɛmplet page.

This template uses Lua:

Module:ChartColors (sandbox)

This template shows standard color templates: Category20 and Plotter, and the code to include with {{legend}}.

To translate or review the translation of the module to your language, edit carefully Data:I18n/ChartColorLegends.tab.

Full color of diagram palettes. Moving the mouse cursor over each box the color number appears.

Palette	Code	Note
Category20 (When n > 10)	`{{ChartColors\|Categ20\|20}}`	Normal order
	`{{ChartColors\|Categ20_3\|20}}`	The first color is the 3rd
	`{{ChartColors\|Categ20_i_3\|20}}`	Inverted order
Category10 (Categ20 in the code. When n < 11)	`{{ChartColors\|Categ20\|10}}`	Normal order (1st, 3rd, 5th, ... of Category20)
	`{{ChartColors\|Categ20_2\|10}}`	The first color is the 2nd (of Category20)
	`{{ChartColors\|Categ20_3\|10}}`	The first color is the 3rd (of Category20)
	`{{ChartColors\|Categ20_i\|10}}`	Inverted order
Plotter	`{{ChartColors\|Plotter\|26}}`	Normal order
Plotter	`{{ChartColors\|Plotter_i\|26}}`	Inverted order

Syntax

{{ChartColorLegends|color palette|color number|column number|..}}

The color number must be 1 to 20 (Categ20) or 1 to 26 (Plotter).

Template data

TemplateData for ChartColorLegends

Display a standard palette

Template parameters
Parameter		Description	Type	Status
Palette name	`1`	Name of the color palette to use (Categ20 or Plotter)	Line	required
Color number	`2`	Color number required from 1 to 20	Number	required
Column width	`3`	Width of columns showing colors (and text). Leave blank for no columns	String	required
Legend 1	`4`	Text for the 1st color	Line	optional
Legend 2	`5`	Text for the 2nd color	Line	optional
Legend 3	`6`	Text for the 3rd color	Line	optional
Legend 4	`7`	Text for the 4th color	Line	optional
Legend 5	`8`	Text for the 5th color	Line	optional
Legend 6	`9`	Text for the 6th color	Line	optional
Legend 7	`10`	Text for the 7th color	Line	optional
Legend 8	`11`	Text for the 8th color	Line	optional
Legend 9	`12`	Text for the 9th color	Line	optional
Legend 10	`13`	Text for the 10th color	Line	optional
Legend 11	`14`	Text for the 11th color	Line	optional
Legend 12	`15`	Text for the 12th color	Line	optional
Legend 13	`16`	Text for the 13th color	Line	optional
Legend 14	`17`	Text for the 14th color	Line	optional
Legend 15	`18`	Text for the 15th color	Line	optional
Legend 16	`19`	Text for the 16th color	Line	optional
Legend 17	`20`	Text for the 17th color	Line	optional
Legend 18	`21`	Text for the 18th color	Line	optional
Legend 19	`22`	Text for the 19th color	Line	optional
Legend 20	`23`	Text for the 20th color	Line	optional

Examples

With legend text

{{ChartColorLegends|Categ20|4||One|Two|Three|Four}}

produces:

One

Two

Three

Four

 {{legend|#1f77b4|One}}
 {{legend|#ff7f0e|Two}}
 {{legend|#2ca02c|Three}}
 {{legend|#d62728|Four}}

Without legend text

{{ChartColorLegends|Plotter|10|30em}}

produces:

red

blue

green

yellow

fuchsia

aqua

brown

orange

purple

sienna

{{div col|colwidth=30em}}
 {{legend|red|}}
 {{legend|blue|}}
 {{legend|green|}}
 {{legend|yellow|}}
 {{legend|fuchsia|}}
 {{legend|aqua|}}
 {{legend|brown|}}
 {{legend|orange|}}
 {{legend|purple|}}
 {{legend|sienna|}}
{{div col end}}