-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathnavigation_toolbar.html
More file actions
329 lines (297 loc) · 18.9 KB
/
navigation_toolbar.html
File metadata and controls
329 lines (297 loc) · 18.9 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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<!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>Interactive navigation — Matplotlib 3.1.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
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="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script type="text/javascript" src="../_static/copybutton.js"></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.0 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.0 documentation" href="../index.html" />
<link rel="up" title="Interactive plots" href="interactive.html" />
<link rel="next" title="Using matplotlib in a python shell" href="shell.html" />
<link rel="prev" title="Interactive plots" href="interactive.html" />
<link rel="canonical" href="https://matplotlib.org/3.2.2/users/navigation_toolbar.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.0). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</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.0</span></div>
<img src="../_static/logo2.png" 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>
<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="shell.html" title="Using matplotlib in a python shell"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="interactive.html" title="Interactive plots"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="../api/index.html">API</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li><a href="index.html" >User's Guide</a> »</li>
<li><a href="interactive.html" accesskey="U">Interactive plots</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Interactive navigation</a><ul>
<li><a class="reference internal" href="#navigation-keyboard-shortcuts">Navigation Keyboard Shortcuts</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">User's Guide</a><ul>
<li><a href="interactive.html">Interactive plots</a><ul>
<li>Previous: <a href="interactive.html" title="previous chapter">Interactive plots</a></li>
<li>Next: <a href="shell.html" title="next chapter">Using matplotlib in a python shell</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/users/navigation_toolbar.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="interactive-navigation">
<span id="navigation-toolbar"></span><h1>Interactive navigation<a class="headerlink" href="#interactive-navigation" title="Permalink to this headline">¶</a></h1>
<img alt="../_images/toolbar.png" src="../_images/toolbar.png" />
<p>All figure windows come with a navigation toolbar, which can be used
to navigate through the data set. Here is a description of each of
the buttons at the bottom of the toolbar</p>
<img alt="../_images/home_large.png" src="../_images/home_large.png" />
<img alt="../_images/back_large.png" src="../_images/back_large.png" />
<img alt="../_images/forward_large.png" src="../_images/forward_large.png" />
<dl class="docutils">
<dt>The <code class="docutils literal notranslate"><span class="pre">Home</span></code>, <code class="docutils literal notranslate"><span class="pre">Forward</span></code> and <code class="docutils literal notranslate"><span class="pre">Back</span></code> buttons</dt>
<dd>These are akin to a web browser's home, forward and back controls.
<code class="docutils literal notranslate"><span class="pre">Forward</span></code> and <code class="docutils literal notranslate"><span class="pre">Back</span></code> are used to navigate back and forth between
previously defined views. They have no meaning unless you have already
navigated somewhere else using the pan and zoom buttons. This is analogous
to trying to click <code class="docutils literal notranslate"><span class="pre">Back</span></code> on your web browser before visiting a
new page or <code class="docutils literal notranslate"><span class="pre">Forward</span></code> before you have gone back to a page --
nothing happens. <code class="docutils literal notranslate"><span class="pre">Home</span></code> always takes you to the
first, default view of your data. Again, all of these buttons should
feel very familiar to any user of a web browser.</dd>
</dl>
<img alt="../_images/move_large.png" src="../_images/move_large.png" />
<dl class="docutils">
<dt>The <code class="docutils literal notranslate"><span class="pre">Pan/Zoom</span></code> button</dt>
<dd><p class="first">This button has two modes: pan and zoom. Click the toolbar button
to activate panning and zooming, then put your mouse somewhere
over an axes. Press the left mouse button and hold it to pan the
figure, dragging it to a new position. When you release it, the
data under the point where you pressed will be moved to the point
where you released. If you press 'x' or 'y' while panning the
motion will be constrained to the x or y axis, respectively. Press
the right mouse button to zoom, dragging it to a new position.
The x axis will be zoomed in proportionately to the rightward
movement and zoomed out proportionately to the leftward movement.
The same is true for the y axis and up/down motions. The point under your
mouse when you begin the zoom remains stationary, allowing you to
zoom in or out around that point as much as you wish. You can use the
modifier keys 'x', 'y' or 'CONTROL' to constrain the zoom to the x
axis, the y axis, or aspect ratio preserve, respectively.</p>
<p class="last">With polar plots, the pan and zoom functionality behaves
differently. The radius axis labels can be dragged using the left
mouse button. The radius scale can be zoomed in and out using the
right mouse button.</p>
</dd>
</dl>
<img alt="../_images/zoom_to_rect_large.png" src="../_images/zoom_to_rect_large.png" />
<dl class="docutils">
<dt>The <code class="docutils literal notranslate"><span class="pre">Zoom-to-rectangle</span></code> button</dt>
<dd>Click this toolbar button to activate this mode. Put your mouse somewhere
over an axes and press a mouse button. Define a rectangular region by
dragging the mouse while holding the button to a new location. When using
the left mouse button, the axes view limits will be zoomed to the defined
region. When using the right mouse button, the axes view limits will be
zoomed out, placing the original axes in the defined region.</dd>
</dl>
<img alt="../_images/subplots_large.png" src="../_images/subplots_large.png" />
<dl class="docutils">
<dt>The <code class="docutils literal notranslate"><span class="pre">Subplot-configuration</span></code> button</dt>
<dd>Use this tool to configure the appearance of the subplot:
you can stretch or compress the left, right, top, or bottom
side of the subplot, or the space between the rows or
space between the columns.</dd>
</dl>
<img alt="../_images/filesave_large.png" src="../_images/filesave_large.png" />
<dl class="docutils">
<dt>The <code class="docutils literal notranslate"><span class="pre">Save</span></code> button</dt>
<dd>Click this button to launch a file save dialog. You can save
files with the following extensions: <code class="docutils literal notranslate"><span class="pre">png</span></code>, <code class="docutils literal notranslate"><span class="pre">ps</span></code>, <code class="docutils literal notranslate"><span class="pre">eps</span></code>,
<code class="docutils literal notranslate"><span class="pre">svg</span></code> and <code class="docutils literal notranslate"><span class="pre">pdf</span></code>.</dd>
</dl>
<div class="section" id="navigation-keyboard-shortcuts">
<span id="key-event-handling"></span><h2>Navigation Keyboard Shortcuts<a class="headerlink" href="#navigation-keyboard-shortcuts" title="Permalink to this headline">¶</a></h2>
<p>The following table holds all the default keys, which can be overwritten by use of your matplotlibrc (#keymap.*).</p>
<table border="1" class="docutils">
<colgroup>
<col width="41%" />
<col width="59%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Command</th>
<th class="head">Keyboard Shortcut(s)</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Home/Reset</td>
<td><strong>h</strong> or <strong>r</strong> or <strong>home</strong></td>
</tr>
<tr class="row-odd"><td>Back</td>
<td><strong>c</strong> or <strong>left arrow</strong> or <strong>backspace</strong></td>
</tr>
<tr class="row-even"><td>Forward</td>
<td><strong>v</strong> or <strong>right arrow</strong></td>
</tr>
<tr class="row-odd"><td>Pan/Zoom</td>
<td><strong>p</strong></td>
</tr>
<tr class="row-even"><td>Zoom-to-rect</td>
<td><strong>o</strong></td>
</tr>
<tr class="row-odd"><td>Save</td>
<td><strong>ctrl</strong> + <strong>s</strong></td>
</tr>
<tr class="row-even"><td>Toggle fullscreen</td>
<td><strong>f</strong> or <strong>ctrl</strong> + <strong>f</strong></td>
</tr>
<tr class="row-odd"><td>Close plot</td>
<td><strong>ctrl</strong> + <strong>w</strong></td>
</tr>
<tr class="row-even"><td>Close all plots</td>
<td><strong>shift</strong> + <strong>w</strong></td>
</tr>
<tr class="row-odd"><td>Constrain pan/zoom to x axis</td>
<td>hold <strong>x</strong> when panning/zooming with mouse</td>
</tr>
<tr class="row-even"><td>Constrain pan/zoom to y axis</td>
<td>hold <strong>y</strong> when panning/zooming with mouse</td>
</tr>
<tr class="row-odd"><td>Preserve aspect ratio</td>
<td>hold <strong>CONTROL</strong> when panning/zooming with mouse</td>
</tr>
<tr class="row-even"><td>Toggle major grids</td>
<td><strong>g</strong> when mouse is over an axes</td>
</tr>
<tr class="row-odd"><td>Toggle minor grids</td>
<td><strong>G</strong> when mouse is over an axes</td>
</tr>
<tr class="row-even"><td>Toggle x axis scale (log/linear)</td>
<td><strong>L</strong> or <strong>k</strong> when mouse is over an axes</td>
</tr>
<tr class="row-odd"><td>Toggle y axis scale (log/linear)</td>
<td><strong>l</strong> when mouse is over an axes</td>
</tr>
</tbody>
</table>
<p>If you are using <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.pyplot</span></code></a> the toolbar will be created
automatically for every figure. If you are writing your own user
interface code, you can add the toolbar as a widget. The exact syntax
depends on your UI, but we have examples for every supported UI in the
<code class="docutils literal notranslate"><span class="pre">matplotlib/examples/user_interfaces</span></code> directory. Here is some
example code for GTK+ 3:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">gi</span>
<span class="n">gi</span><span class="o">.</span><span class="n">require_version</span><span class="p">(</span><span class="s1">'Gtk'</span><span class="p">,</span> <span class="s1">'3.0'</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">gi.repository</span> <span class="k">import</span> <span class="n">Gtk</span>
<span class="kn">from</span> <span class="nn">matplotlib.figure</span> <span class="k">import</span> <span class="n">Figure</span>
<span class="kn">from</span> <span class="nn">matplotlib.backends.backend_gtk3agg</span> <span class="k">import</span> <span class="n">FigureCanvas</span>
<span class="kn">from</span> <span class="nn">matplotlib.backends.backend_gtk3</span> <span class="k">import</span> <span class="p">(</span>
<span class="n">NavigationToolbar2GTK3</span> <span class="k">as</span> <span class="n">NavigationToolbar</span><span class="p">)</span>
<span class="n">win</span> <span class="o">=</span> <span class="n">Gtk</span><span class="o">.</span><span class="n">Window</span><span class="p">()</span>
<span class="n">win</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">"destroy"</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">Gtk</span><span class="o">.</span><span class="n">main_quit</span><span class="p">())</span>
<span class="n">win</span><span class="o">.</span><span class="n">set_default_size</span><span class="p">(</span><span class="mi">400</span><span class="p">,</span><span class="mi">300</span><span class="p">)</span>
<span class="n">win</span><span class="o">.</span><span class="n">set_title</span><span class="p">(</span><span class="s2">"Embedding in GTK"</span><span class="p">)</span>
<span class="n">vbox</span> <span class="o">=</span> <span class="n">Gtk</span><span class="o">.</span><span class="n">VBox</span><span class="p">()</span>
<span class="n">win</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">vbox</span><span class="p">)</span>
<span class="n">fig</span> <span class="o">=</span> <span class="n">Figure</span><span class="p">(</span><span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span><span class="mi">4</span><span class="p">),</span> <span class="n">dpi</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">])</span>
<span class="n">canvas</span> <span class="o">=</span> <span class="n">FigureCanvas</span><span class="p">(</span><span class="n">fig</span><span class="p">)</span> <span class="c1"># a Gtk.DrawingArea</span>
<span class="n">vbox</span><span class="o">.</span><span class="n">pack_start</span><span class="p">(</span><span class="n">canvas</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">toolbar</span> <span class="o">=</span> <span class="n">NavigationToolbar</span><span class="p">(</span><span class="n">canvas</span><span class="p">,</span> <span class="n">win</span><span class="p">)</span>
<span class="n">vbox</span><span class="o">.</span><span class="n">pack_start</span><span class="p">(</span><span class="n">toolbar</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">win</span><span class="o">.</span><span class="n">show_all</span><span class="p">()</span>
<span class="n">Gtk</span><span class="o">.</span><span class="n">main</span><span class="p">()</span>
</pre></div>
</div>
</div>
</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 May 18, 2019.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v3.1.0-4-g0078324e4.
</div>
</body>
<footer>
</footer>
</html>