-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathmatplotlib.animation.TimedAnimation.html
More file actions
220 lines (193 loc) · 12.4 KB
/
matplotlib.animation.TimedAnimation.html
File metadata and controls
220 lines (193 loc) · 12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.animation.TimedAnimation — Matplotlib 3.1.3 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css?v3.1.3-2-g782f6ef56"
type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<script type="text/javascript" src="../../_static/clipboard.min.js"></script>
<script type="text/javascript" src="../../_static/copybutton.js"></script>
<script type="text/javascript">var copybuttonSkipText = '>>> ';</script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.1.3 documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html"
/>
<link rel="search" title="Search" href="../../search.html"
/>
<link rel="top" title="Matplotlib 3.1.3 documentation" href="../../index.html" />
<link rel="up" title="matplotlib.animation" href="../animation_api.html" />
<link rel="next" title="matplotlib.animation.MovieWriterRegistry" href="matplotlib.animation.MovieWriterRegistry.html" />
<link rel="prev" title="Frame grabbing" href="../../gallery/animation/frame_grabbing_sgskip.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.TimedAnimation.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.1.3). For the latest version see <a href="https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.TimedAnimation.html">https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.TimedAnimation.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.1.3</span></div>
<img src="../../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../../users/installing.html">Installation</a></li>
<li><a href="../../contents.html">Documentation</a></li>
<li><a href="../../gallery/index.html">Examples</a></li>
<li><a href="../../tutorials/index.html">Tutorials</a></li>
<li><a href="../../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="matplotlib.animation.MovieWriterRegistry.html" title="matplotlib.animation.MovieWriterRegistry"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../../gallery/animation/frame_grabbing_sgskip.html" title="Frame grabbing"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../contents.html">contents</a> »</li>
<li><a href="../index.html" >API Overview</a> »</li>
<li><a href="../animation_api.html" accesskey="U"><code class="docutils literal notranslate"><span class="pre">matplotlib.animation</span></code></a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">API Overview</a><ul>
<li><a href="../animation_api.html"><code class="docutils literal notranslate"><span class="pre">matplotlib.animation</span></code></a><ul>
<li>Previous: <a href="../../gallery/animation/frame_grabbing_sgskip.html" title="previous chapter">Frame grabbing</a></li>
<li>Next: <a href="matplotlib.animation.MovieWriterRegistry.html" title="next chapter">matplotlib.animation.MovieWriterRegistry</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../../_sources/api/_as_gen/matplotlib.animation.TimedAnimation.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="matplotlib-animation-timedanimation">
<h1>matplotlib.animation.TimedAnimation<a class="headerlink" href="#matplotlib-animation-timedanimation" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="matplotlib.animation.TimedAnimation">
<em class="property">class </em><code class="descclassname">matplotlib.animation.</code><code class="descname">TimedAnimation</code><span class="sig-paren">(</span><em>fig</em>, <em>interval=200</em>, <em>repeat_delay=None</em>, <em>repeat=True</em>, <em>event_source=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/matplotlib/animation.html#TimedAnimation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.animation.TimedAnimation" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="matplotlib.animation.Animation.html#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><code class="xref py py-class docutils literal notranslate"><span class="pre">Animation</span></code></a> subclass for time-based animation.</p>
<p>A new frame is drawn every <em>interval</em> milliseconds.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>fig</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a></span></dt>
<dd><p class="first last">The figure object that is used to get draw, resize, and any
other needed events.</p>
</dd>
<dt><strong>interval</strong> <span class="classifier-delimiter">:</span> <span class="classifier">number, optional</span></dt>
<dd><p class="first last">Delay between frames in milliseconds. Defaults to 200.</p>
</dd>
<dt><strong>repeat_delay</strong> <span class="classifier-delimiter">:</span> <span class="classifier">number, optional</span></dt>
<dd><p class="first last">If the animation in repeated, adds a delay in milliseconds
before repeating the animation. Defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
</dd>
<dt><strong>repeat</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
<dd><p class="first last">Controls whether the animation should repeat when the sequence
of frames is completed. Defaults to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
</dd>
<dt><strong>blit</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
<dd><p class="first last">Controls whether blitting is used to optimize drawing. Defaults
to <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.animation.TimedAnimation.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>self</em>, <em>fig</em>, <em>interval=200</em>, <em>repeat_delay=None</em>, <em>repeat=True</em>, <em>event_source=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/matplotlib/animation.html#TimedAnimation.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.animation.TimedAnimation.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
</dd></dl>
<p class="rubric">Methods</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#matplotlib.animation.TimedAnimation.__init__" title="matplotlib.animation.TimedAnimation.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(self, fig[, interval, ...])</td>
<td>Initialize self.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">new_frame_seq</span></code>(self)</td>
<td>Return a new sequence of frame information.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">new_saved_frame_seq</span></code>(self)</td>
<td>Return a new sequence of saved/cached frame information.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">save</span></code>(self, filename[, writer, fps, dpi, ...])</td>
<td>Save the animation as a movie file by drawing every frame.</td>
</tr>
<tr class="row-odd"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_html5_video</span></code>(self[, embed_limit])</td>
<td>Convert the animation to an HTML5 <code class="docutils literal notranslate"><span class="pre"><video></span></code> tag.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_jshtml</span></code>(self[, fps, embed_frames, ...])</td>
<td>Generate HTML representation of the animation</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Feb 09, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v3.1.3-2-g782f6ef56.
</div>
</body>
<footer>
</footer>
</html>