animatplot.blocks.Update

class animatplot.blocks.Update(func, length, fargs=[], ax=None)[source]

For providing a custom update method

This block allows you to write a custom update method to provide functionality not available with other blocks.

Parameters:
  • func (callable) – This function will be called once for each frame of the animation. The first argument to this function must be an integer representing the frame number. It should return a matplotlib artist.
  • length (int) – the number of frames to display
  • fargs (list, optional) – a list of arguments to pass into func
  • ax (a matplotlib.axes.Axes, optional) – The matplotlib axes to attach the block to. Defaults to matplotlib.pyplot.gca()
ax

matplotlib.axes.Axes – The matplotlib axes that the block is attached to.

Methods

__init__ Initialize self.
__init__(func, length, fargs=[], ax=None)[source]

Initialize self. See help(type(self)) for accurate signature.