register_cmaps
- register_cmaps(*args, user=None, local=None, default=False)[source]
Register named colormaps. This is called on import.
- Parameters:
*args (
path-specorContinuousColormap, optional) – The colormaps to register. These can be file paths containing RGB data orContinuousColormapinstances. By default, if positional arguments are passed, thenuseris set toFalse.Valid file extensions are listed in the below table. Note that colormaps are registered according to their filenames – for example,
name.xyzwill be registered as'name'.Extension
Description
.jsonJSON database of the channel segment data.
.hexComma-delimited list of HEX strings.
.rgb,.txt3-4 column table of channel values.
user (
bool, optional) – Whether to reload colormaps fromuser_folder. Default isFalseif positional arguments were passed andTrueotherwise.local (
bool, optional) – Whether to reload colormaps fromlocal_folders. Default isFalseif positional arguments were passed andTrueotherwise.default (
bool, default:False) – Whether to reload the default colormaps packaged with ultraplot. Default is alwaysFalse.