Prepare Pre-defined HCL Palettes

Description

Prepares the pre-specified hclpalettes. Reads the config files and creates a set of defaultpalette objects.

Usage

hclpalettes(files=None, files_regex=None)

Arguments

filesNone, str list: If None (default) the default color palette configuration from within the package will be loaded. A path to a custom config file (str) or a list of paths can be provided to read custom palettes.
files_regexNone, str: Additional regular expression to filter files. Only used if files = None.

Methods

hclpalettes.get_palette(name): Get Palette by Name
hclpalettes.get_palette_types(): Get Palette Types
hclpalettes.get_palettes(type_=None, exact=False): Get Type-Specific Palettes
hclpalettes.length(): Get Number of Palettes
hclpalettes.plot(n=5): Palette Swatch Plot

Examples

from colorspace import hclpalettes
hclpals = hclpalettes()
hclpals

HCL palettes

Type:  Basic: Sequential (single-hue)
Names: Grays, Light Grays, Blues 2, Purples 2, Reds 2
       Greens 2

Type:  Basic: Sequential (multi-hue)
Names: Purple-Blue, Red-Purple, Red-Blue, Purple-Orange
       Blue-Yellow, Green-Yellow, Red-Yellow, Heat, Heat 2
       Terrain, Terrain 2, Viridis, Plasma, Dark Mint, Mint
       Emrld, BluYl, ag_GrnYl, Peach, PinkYl

Type:  Basic: Qualitative
Names: Pastel 1, Dark 2, Dark 3, Set 2, Set 3, Warm, Cold
       Harmonic, Dynamic

Type:  Basic: Diverging
Names: Blue-Red, Blue-Red 2, Blue-Yellow 2, Blue-Yellow 3
       Green-Orange, Cyan-Magenta, Tropic

Type:  Advanced: Sequential (single-hue)
Names: Blues 3, Purples 3, Reds 3, Greens 3, Oslo

Type:  Advanced: Sequential (multi-hue)
Names: Purple-Yellow, Inferno, Rocket, Mako, BluGrn, Teal
       TealGrn, Burg, BurgYl, RedOr, OrYel, Purp, PurpOr
       Sunset, Magenta, SunsetDark, ag_Sunset, BrwnYl, YlOrRd
       YlOrBr, OrRd, Oranges, YlGn, YlGnBu, Reds, RdPu, PuRd
       Purples, PuBuGn, PuBu, Greens, BuGn, GnBu, BuPu, Blues
       Lajolla, Turku, Hawaii, Batlow

Type:  Advanced: DivergingX
Names: ArmyRose, Earth, Fall, Geyser, TealRose, Temps, PuOr
       RdBu, RdGy, PiYG, PRGn, BrBG, RdYlBu, RdYlGn, Spectral
       Zissou 1, Cividis, Roma

Type:  Advanced: Diverging
Names: ArmyRose, Earth, Fall, Geyser, TealRose, Temps, PuOr
       RdBu, RdGy, PiYG, PRGn, BrBG, RdYlBu, RdYlGn, Spectral
       Zissou 1, Cividis, Roma, Blue-Red 3, Red-Green
       Purple-Green, Purple-Brown, Green-Brown, Broc, Cork
       Vik, Berlin, Lisbon, Tofino

# Palette swatch plots with 5 colors each
hclpals.plot(n = 5);

# Palette swatch plots with 11 colors each
hclpals.plot(n = 11);