plotnine.scale_fill_distiller

scale_fill_distiller(
    type="seq",
    palette=1,
    values=None,
    direction=1,
    *,
    name=None,
    breaks=True,
    limits=None,
    labels=True,
    expand=None,
    guide="colorbar",
    na_value="#7F7F7F",
    aesthetics=(),
    rescaler=rescale,
    oob=censor,
    minor_breaks=True,
    trans=None
)

Sequential, diverging continuous color scales

Init Parameters

type: Literal['diverging', 'qualitative', 'sequential', 'div', 'qual', 'seq'] = 'seq'

Type of data

palette: int | str = 1

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

values: Sequence[float] | None = None

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: Literal[1, -1] = 1

Sets the order of colors in the scale. If 1, colors are as output brewer_pal. If -1, the order of colors is reversed.

Parameter Attributes

name: str | None = None

The name of the scale. It is used as the label of the axis or the title of the guide. Suitable defaults are chosen depending on the type of scale.

breaks: ContinuousBreaksUser = True

Major breaks

limits: ContinuousLimitsUser = None

Limits of the scale. Most commonly, these are the minimum & maximum values for the scale. If not specified they are derived from the data. It may also be a function that takes the derived limits and transforms them into the final limits.

labels: ScaleLabelsUser = True

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

expand: (
    tuple[float, float]
    | tuple[float, float, float, float]
    | None
) = None

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.

guide: Literal["legend", "colorbar"] | None = "colorbar"

na_value: str = "#7F7F7F"

Color of missing values.

aesthetics: Sequence[ScaledAestheticsName] = ()

Aesthetics affected by this scale. These are defined by each scale and the user should probably not change them. Have fun.

rescaler: PRescale = rescale

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.

oob: PCensor = censor

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

minor_breaks: MinorBreaksUser = True

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.

trans: TransUser = None

The transformation of the scale. Either name of a trans function or a trans function. See mizani.transforms for possible options.