matplotlib.animation.FuncAnimation — Matplotlib 3.10.3 documentation (original) (raw)

class matplotlib.animation.FuncAnimation(fig, func, frames=None, init_func=None, fargs=None, save_count=None, *, cache_frame_data=True, **kwargs)[source]#

TimedAnimation subclass that makes an animation by repeatedly calling a function func.

Note

You must store the created Animation in a variable that lives as long as the animation should run. Otherwise, the Animation object will be garbage-collected and the animation stops.

Parameters:

figFigure

The figure object used to get needed events, such as draw or resize.

funccallable

The function to call at each frame. The first argument will be the next value in frames. Any additional positional arguments can be supplied using functools.partial or via the _fargs_parameter.

The required signature is:

def func(frame, *fargs) -> iterable_of_artists

It is often more convenient to provide the arguments usingfunctools.partial. In this way it is also possible to pass keyword arguments. To pass a function with both positional and keyword arguments, set all arguments as keyword arguments, just leaving the_frame_ argument unset:

def func(frame, art, *, y=None): ...

ani = FuncAnimation(fig, partial(func, art=ln, y='foo'))

If blit == True, func must return an iterable of all artists that were modified or created. This information is used by the blitting algorithm to determine which parts of the figure have to be updated. The return value is unused if blit == False and may be omitted in that case.

framesiterable, int, generator function, or None, optional

Source of data to pass func and each frame of the animation

• If an iterable, then simply use the values provided. If the iterable has a length, it will override the save_count kwarg.
• If an integer, then equivalent to passing range(frames)
• If a generator function, then must have the signature:
  def gen_function() -> obj
• If None, then equivalent to passing itertools.count.

In all of these cases, the values in frames is simply passed through to the user-supplied func and thus can be of any type.

init_funccallable, optional

A function used to draw a clear frame. If not given, the results of drawing from the first item in the frames sequence will be used. This function will be called once before the first frame.

The required signature is:

def init_func() -> iterable_of_artists

If blit == True, init_func must return an iterable of artists to be re-drawn. This information is used by the blitting algorithm to determine which parts of the figure have to be updated. The return value is unused if blit == False and may be omitted in that case.

fargstuple or None, optional

Additional arguments to pass to each call to func. Note: the use offunctools.partial is preferred over fargs. See func for details.

save_countint, optional

Fallback for the number of values from frames to cache. This is only used if the number of frames cannot be inferred from frames, i.e. when it's an iterator without length or a generator.

intervalint, default: 200

Delay between frames in milliseconds.

repeat_delayint, default: 0

The delay in milliseconds between consecutive animation runs, if_repeat_ is True.

repeatbool, default: True

Whether the animation repeats when the sequence of frames is completed.

blitbool, default: False

Whether blitting is used to optimize drawing. Note: when using blitting, any animated artists will be drawn according to their zorder; however, they will be drawn on top of any previous artists, regardless of their zorder.

cache_frame_databool, default: True

Whether frame data is cached. Disabling cache might be helpful when frames contain large objects.

__init__(fig, func, frames=None, init_func=None, fargs=None, save_count=None, *, cache_frame_data=True, **kwargs)[source]#

Methods

new_frame_seq()[source]#

Return a new sequence of frame information.

new_saved_frame_seq()[source]#

Return a new sequence of saved/cached frame information.