Template:ChartColorLegends/doc

From MOASSpedia
Jump to navigation Jump to search

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 Resulting colors 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
{{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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for ChartColorLegends

Display a standard palette

Template parameters

ParameterDescriptionTypeStatus
Palette name1

Name of the color palette to use (Categ20 or Plotter)

Linerequired
Color number2

Color number required from 1 to 20

Numberrequired
Column width3

Width of columns showing colors (and text). Leave blank for no columns

Stringrequired
Legend 14

Text for the 1st color

Lineoptional
Legend 25

Text for the 2nd color

Lineoptional
Legend 36

Text for the 3rd color

Lineoptional
Legend 47

Text for the 4th color

Lineoptional
Legend 58

Text for the 5th color

Lineoptional
Legend 69

Text for the 6th color

Lineoptional
Legend 710

Text for the 7th color

Lineoptional
Legend 811

Text for the 8th color

Lineoptional
Legend 912

Text for the 9th color

Lineoptional
Legend 1013

Text for the 10th color

Lineoptional
Legend 1114

Text for the 11th color

Lineoptional
Legend 1215

Text for the 12th color

Lineoptional
Legend 1316

Text for the 13th color

Lineoptional
Legend 1417

Text for the 14th color

Lineoptional
Legend 1518

Text for the 15th color

Lineoptional
Legend 1619

Text for the 16th color

Lineoptional
Legend 1720

Text for the 17th color

Lineoptional
Legend 1821

Text for the 18th color

Lineoptional
Legend 1922

Text for the 19th color

Lineoptional
Legend 2023

Text for the 20th color

Lineoptional

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}}
    

    See also