plotnine.scales.scale_fill_distiller

class plotnine.scales.scale_fill_distiller(type='seq', palette=1, values=None, direction=- 1, **kwargs)[source]

Sequential, diverging continuous color scales

Parameters
typestr in ['seq', 'div']

Type of data. Sequential, diverging or qualitative

paletteint | str

If a string, will use that named palette. If a number, will index into the list of palettes of appropriate type. Default is 1

valueslist, optional

list of points in the range [0, 1] at which to place each color. Must be the same size as colors. Default to evenly space the colors

direction: int in ``[-1, 1]``

Sets the order of colors in the scale. If 1 colors are as output by mizani.palettes.brewer_pal(). If -1, the default, the order of colors is reversed.

colorslist

list of colors

breaksarray_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.

expandtuple, optional

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

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

For example,

  • (0, 0) - Do not expand.

  • (0, 1) - Expand lower and upper limits by 1 unit.

  • (1, 0) - Expand lower and upper limits by 100%.

  • (0, 0, 0, 0) - Do not expand, as (0, 0).

  • (0, 0, 0, 1) - Expand upper limit by 1 unit.

  • (0, 1, 0.1, 0) - Expand lower limit by 1 unit and upper limit by 10%.

  • (0, 0, 0.1, 2) - Expand upper limit by 10% plus 2 units.

If not specified, suitable defaults are chosen.

namestr, optional

Name used as the label of the scale. This is what shows up as the axis label or legend title. Suitable defaults are chosen depending on the type of scale.

labelslist 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.

limitsarray_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.

aestheticslist, 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.

transstr | function

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

oobfunction

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

minor_breakslist-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.

rescalerfunction, 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_valuestr

Color of missing values. Default is 'None'