mpl_bsic.format_timeseries_axis#

mpl_bsic.format_timeseries_axis(ax, time_unit, freq, fmt=None)[source]#

Format the x-axis of a timeseries plot.

It sets the major locator and formatter for the x-axis. Note that this function does not take as an input the figure, but just the matplotlib Axes instance.

Parameters:

axmatplotlib.axes.Axes: Matplotlib Axes instance.
time_unitLiteral[‘Y’, ‘M’, ‘W’, ‘D’]: Time unit to use. Can be “Y” for years, “M” for months, ‘W’ for weeks, or “D” for days.
freqint: Time Frequency. For example, if time_unit is “M” and freq is 3, then the x-axis will have a tick every 3 months.
fmtstr | None: Date Format which will be fed to matplotlib.dates.DateFormatter. If None, the default format will be used (%b-%y).

Raises:

Exception: If the time frequency is not supported.