register_cycles

register_cycles(*args, user=None, local=None, default=False)[source]

Register named color cycles. This is called on import.

Parameters:

  • *args (path-spec or DiscreteColormap, optional) – The color cycles to register. These can be file paths containing RGB data or DiscreteColormap instances. By default, if positional arguments are passed, then user is set to False.

    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 from user_folder. Default is False if positional arguments were passed and True otherwise.

  • local (bool, optional) – Whether to reload color cycles from local_folders. Default is False if positional arguments were passed and True otherwise.

  • default (bool, default: False) – Whether to reload the default color cycles packaged with ultraplot. Default is always False.

See also

register_cmaps, register_colors, register_fonts, ultraplot.demos.show_cycles