plotnine.scales.scale_fill_cmap

class plotnine.scales.scale_fill_cmap(name='viridis', lut=None, **kwargs)[source]

Create color scales using Matplotlib colormaps

Parameters:
name : str

A standard Matplotlib colormap name. The default is viridis. For the list of names checkout the output of matplotlib.cm.cmap_d.keys() or see the documentation.

lut : None | int

This is the number of entries desired in the lookup table. Default is None, leave it up Matplotlib.

breaks : array_like or callable, optional

Major break points. Alternatively, a callable that takes a tuple of limits and returns a list of breaks. Default is to automatically calculate the breaks.

expand : array_like, optional

Multiplicative and additive expansion constants that determine how the scale is expanded. If specified must of of length 2 or 4. Specifically the the values are of this order:

(mul, add)
(mul_low, add_low, mul_high, add_high)

If not specified, suitable defaults are chosen.

labels : list or callable, optional

List of str. Labels at the breaks. Alternatively, a callable that takes an array_like of break points as input and returns a list of strings.

limits : array_like, optional

Limits of the scale. Most commonly, these are the min & max values for the scales. For scales that deal with categoricals, these may be a subset or superset of the categories.

palette : callable, optional

Function to map data points onto the scale. Most scales define their own palettes.

aesthetics : list, optional

list of str. Aesthetics covered by the scale. These are defined by each scale and the user should probably not change them. Have fun.

trans : str | function

Name of a trans function or a trans function. See mizani.transforms for possible options.

oob : function

Function to deal with out of bounds (limits) data points. Default is to turn them into np.nan, which then get dropped.

minor_breaks : list-like or int or callable or None

If a list-like, it is the minor breaks points. If an integer, it is the number of minor breaks between any set of major breaks. If a function, it should have the signature func(limits) and return a list-like of consisting of the minor break points. If None, no minor breaks are calculated. The default is to automatically calculate them.

rescaler : function, optional

Function to rescale data points so that they can be handled by the palette. Default is to rescale them onto the [0, 1] range. Scales that inherit from this class may have another default.

na_value : str

Color of missing values. Default is 'None'