plotnine.scale_y_timedelta

scale_y_timedelta(**kwargs)

Continuous y position for timedelta data points

Parameters

breaks : bool | list | callable = True

List of major break points. Or a callable that takes a tuple of limits and returns a list of breaks. If True, automatically calculate the breaks.

expand : tuple = 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.

name : str = None

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.

labels : bool | list | callable = True

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 = None

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.

na_value : scalar = float("nan")

What value to assign to missing values. Default is to assign np.nan.

palette : callable = None

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

aesthetics : list | str = None

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 | callable

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

oob : callable = mizani.bounds.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 : list | int | callable = 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 : callable = mizani.bounds.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.