register_cycles¶
- register_cycles(*args, user=None, default=False)[source]¶
Register named color cycles. This is called on import.
- Parameters
*args (
path-spec
orDiscreteColormap
, optional) – The color cycles to register. These can be file paths containing RGB data orDiscreteColormap
instances. By default, if positional arguments are passed, thenuser
is set toFalse
.Valid file extensions are listed in the below table. Note that color cycles are registered according to their filenames – for example,
name.xyz
will be registered as'name'
.Extension
Description
.hex
Comma-delimited list of HEX strings.
.rgb
,.txt
3-4 column table of channel values.
user (
bool
, optional) – Whether to reload color cycles fromuser_folder
. Default isFalse
if positional arguments were passed andTrue
otherwise.default (
bool
, optional) – Whether to reload the default color cycles packaged with proplot. Default is alwaysFalse
.