You are reading an old version of the documentation (v3.1.1). For the latest version see https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.TimedAnimation.html
Version 3.1.2
matplotlib
Fork me on GitHub

matplotlib.animation.TimedAnimation

class matplotlib.animation.TimedAnimation(fig, interval=200, repeat_delay=None, repeat=True, event_source=None, *args, **kwargs)[source]

Animation subclass for time-based animation.

A new frame is drawn every interval milliseconds.

Parameters:
fig : Figure

The figure object that is used to get draw, resize, and any other needed events.

interval : number, optional

Delay between frames in milliseconds. Defaults to 200.

repeat_delay : number, optional

If the animation in repeated, adds a delay in milliseconds before repeating the animation. Defaults to None.

repeat : bool, optional

Controls whether the animation should repeat when the sequence of frames is completed. Defaults to True.

blit : bool, optional

Controls whether blitting is used to optimize drawing. Defaults to False.

__init__(self, fig, interval=200, repeat_delay=None, repeat=True, event_source=None, *args, **kwargs)[source]

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

Methods

__init__(self, fig[, interval, ...]) Initialize self.
new_frame_seq(self) Return a new sequence of frame information.
new_saved_frame_seq(self) Return a new sequence of saved/cached frame information.
save(self, filename[, writer, fps, dpi, ...]) Save the animation as a movie file by drawing every frame.
to_html5_video(self[, embed_limit]) Convert the animation to an HTML5 <video> tag.
to_jshtml(self[, fps, embed_frames, ...]) Generate HTML representation of the animation