animatplot.blocks.Title¶
-
class
animatplot.blocks.Title(text, ax=None, *args, **kwargs)[source]¶ Animates an axes title.
Follows the same syntax as a format-string, but the values to be replaced must be given as an array of values for each timestep.
Alternatively can just accept a list of strings, one for each timestep.
Parameters: - text (str or list of str) – Text to display as the title. Either supplied as a list of strings, one for each timestep, or as a base string with curly braces for any “replacement fields”.
- ax (matplotlib.axes.Axes, optional) – The matplotlib axes to attach the block to. Defaults to matplotlib.pyplot.gca()
- mpl_kwargs (dict, optional) – Keyword arguments to pass to matplotlib.pyplot.title()
- args (optional) – Passed on to str.format()
- kwargs (optional) – If kwarg matches a field in the format string, then passed on to str.format(), else passed on to matplotlib.axes.Axes.set_title().
-
ax¶ matplotlib axis – The matplotlib axes that the block is attached to.
Methods
__init__Initialize self.