Template:BrewerColorLegends/doc

From blackwiki
Jump to navigation Jump to search

This template shows the Brewer colors with {{legend}} to include in the code. Based on specifications and designs developed by Cynthia Brewer ([1]).

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

Syntax

{{BrewerColorLegends|color palette|color number|column width|..}}

The color number must be 3 to 8-12, depending on the color palette:

Brewer's color palettes

Valid names and full color representation for each palette. Moving the mouse cursor over each box the color number appears.

Sequential (1-9)
  • YlGn
                                       
  • YlGnBu
                                       
  • GnBu
                                       
  • BuGn
                                       
  • PuBuGn
                                       
  • PuBu
                                       
  • BuPu
                                       
  • RdPu
                                       
  • PuRd
                                       
  • OrRd
                                       
  • YlOrRd
                                       
  • YlOrBr
                                       
  • Purples
                                       
  • Blues
                                       
  • Greens
                                       
  • Oranges
                                       
  • Reds
                                       
  • Greys
                                       
Divergent (1-11)
  • PuOr
                                               
  • BrBG
                                               
  • PRGn
                                               
  • PiYG
                                               
  • RdBu
                                               
  • RdGy
                                               
  • RdYlBu
                                               
  • Spectral
                                               
  • RdYlGn
                                               
Qualitative (1-8/12)
  • Accent
                                   
  • Dark2
                                   
  • Paired
                                                   
  • Pastel1
                                       
  • Pastel2
                                   
  • Set1
                                       
  • Set2
                                   
  • Set3
                                                   

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for BrewerColorLegends

Display a Brewer's color palette

Template parameters

ParameterDescriptionTypeStatus
Palette1

Name of the color palette to use

Linerequired
Color number2

Color number required from 3 to 9/12

Numberrequired
Column width3

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

Linerequired
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

Examples

With legend text

{{BrewerColorLegends|Oranges|4|30em|One|Two|Three|Four}}

produces:

  • One
  • Two
  • Three
  • Four
  • {{div col|colwidth=30em}}
     {{legend|#feedde|One}}
     {{legend|#fdbe85|Two}}
     {{legend|#fd8d3c|Three}}
     {{legend|#d94701|Four}}
    {{div col end}}
    

    Without legend text

    {{BrewerColorLegends|Set3|10|20em}}

    produces:

  • 8dd3c7
  • ffffb3
  • bebada
  • fb8072
  • 80b1d3
  • fdb462
  • b3de69
  • fccde5
  • d9d9d9
  • bc80bd
  • {{div col|colwidth=20em}}
     {{legend|#8dd3c7|}}
     {{legend|#ffffb3|}}
     {{legend|#bebada|}}
     {{legend|#fb8072|}}
     {{legend|#80b1d3|}}
     {{legend|#fdb462|}}
     {{legend|#b3de69|}}
     {{legend|#fccde5|}}
     {{legend|#d9d9d9|}}
     {{legend|#bc80bd|}}
    {{div col end}}
    

    See also