plotnine.scales.scale_datetime.scale_datetime

scale_datetime(
    date_breaks=None,
    date_labels=None,
    date_minor_breaks=None,
    *,
    name=None,
    breaks=True,
    limits=None,
    labels=True,
    expand=None,
    guide,
    na_value=np.nan,
    aesthetics=(),
    rescaler=rescale,
    oob=censor,
    minor_breaks=True,
    trans="datetime"
)

Base class for all date/datetime scales

Init Parameters

date_breaks: str | None = None

A string giving the distance between major breaks. For example '2 weeks', '5 years'. If specified, date_breaks takes precedence over breaks.

date_labels: str | None = None

Format string for the labels. See strftime. If specified, date_labels takes precedence over labels.

date_minor_breaks: str | None = None

A string giving the distance between minor breaks. For example '2 weeks', '5 years'. If specified, date_minor_breaks takes precedence over minor_breaks.

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: ( # pyright: ignore[reportIncompatibleVariableOverride]
    tuple[float, timedelta]
    | tuple[float, timedelta, float, timedelta]
    | 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, timedelta(0)) - Do not expand.
• (0, timedelta(days=1)) - Expand lower and upper limits by 1 day.
• (1, 0) - Expand lower and upper limits by 100%.
• (0, 0, 0, timedelta(hours=6)) - Expand upper limit by 6 hours.
• (0, timedelta(minutes=5), 0.1, timdelta(0)) - Expand lower limit by 5 minutes and upper limit by 10%.
• (0, 0, 0.1, timedelta(weeks=2)) - Expand upper limit by 10% plus 2 weeks.

If not specified, suitable defaults are chosen.

guide: GuideTypeT

Whether to include a legend

na_value: Any = np.nan

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

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 = "datetime"