matplotlib / 3.5.1 / _as_gen / matplotlib.animation.timedanimation.html /

matplotlib.animation.TimedAnimation

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

Animation subclass for time-based animation.

A new frame is drawn every interval milliseconds.

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
fig Figure

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

interval int, default: 200

Delay between frames in milliseconds.

repeat_delay int, default: 0

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

repeat bool, default: True

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

blit bool, default: False

Whether blitting is used to optimize drawing.

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

Methods

__init__(fig[, interval, repeat_delay, ...])

new_frame_seq()

Return a new sequence of frame information.

new_saved_frame_seq()

Return a new sequence of saved/cached frame information.

pause()

Pause the animation.

resume()

Resume the animation.

save(filename[, writer, fps, dpi, codec, ...])

Save the animation as a movie file by drawing every frame.

to_html5_video([embed_limit])

Convert the animation to an HTML5 <video> tag.

to_jshtml([fps, embed_frames, default_mode])

Generate HTML representation of the animation.

© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/_as_gen/matplotlib.animation.TimedAnimation.html