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