matplotlib.github.com/3.1.1/users/navigation_toolbar.html at main · matplotlib/matplotlib.github.com

History

338 lines (304 loc) · 19.1 KB

Raw

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

330

331

332

333

334

335

336

337

338

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Interactive navigation — Matplotlib 3.1.2 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.1.2 documentation"

href="../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.1.1). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.1.2</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<ul>

<li><a href="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>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="shell.html" title="Using matplotlib in a python shell"

accesskey="N">next</a> |</li>

<a href="interactive.html" title="Interactive plots"

accesskey="P">previous</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>

<h3>Quick search</h3>

</form>

</div>

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

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

</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>

<h1>Interactive navigation<a class="headerlink" href="#interactive-navigation" title="Permalink to this headline">¶</a></h1>

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

<dt>The <code class="docutils literal notranslate">Home</code>, <code class="docutils literal notranslate">Forward</code> and <code class="docutils literal notranslate">Back</code> buttons</dt>

<dd>These are akin to a web browser's home, forward and back controls.

<code class="docutils literal notranslate">Forward</code> and <code class="docutils literal notranslate">Back</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">Back</code> on your web browser before visiting a

new page or <code class="docutils literal notranslate">Forward</code> before you have gone back to a page --

nothing happens. <code class="docutils literal notranslate">Home</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>

<dt>The <code class="docutils literal notranslate">Pan/Zoom</code> button</dt>

<dd>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.

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.

</dd>

</dl>

<dt>The <code class="docutils literal notranslate">Zoom-to-rectangle</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>

<dt>The <code class="docutils literal notranslate">Subplot-configuration</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>

<dt>The <code class="docutils literal notranslate">Save</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">png</code>, <code class="docutils literal notranslate">ps</code>, <code class="docutils literal notranslate">eps</code>,

</dl>

<h2>Navigation Keyboard Shortcuts<a class="headerlink" href="#navigation-keyboard-shortcuts" title="Permalink to this headline">¶</a></h2>

The following table holds all the default keys, which can be overwritten by use of your matplotlibrc (#keymap.*).

</colgroup>

<tr class="row-odd"><th class="head">Command</th>

<th class="head">Keyboard Shortcut(s)</th>

</tr>

</thead>

<tr class="row-even"><td>Home/Reset</td>

</tr>

<td>c or left arrow or backspace</td>

</tr>

<tr class="row-even"><td>Forward</td>

<td>v or right arrow</td>

</tr>

</tr>

</tr>

</tr>

<tr class="row-even"><td>Toggle fullscreen</td>

</tr>

<tr class="row-odd"><td>Close plot</td>

</tr>

<tr class="row-even"><td>Close all plots</td>

<td>shift + w</td>

</tr>

<tr class="row-odd"><td>Constrain pan/zoom to x axis</td>

<td>hold x when panning/zooming with mouse</td>

</tr>

<tr class="row-even"><td>Constrain pan/zoom to y axis</td>

<td>hold y when panning/zooming with mouse</td>

</tr>

<tr class="row-odd"><td>Preserve aspect ratio</td>

<td>hold CONTROL when panning/zooming with mouse</td>

</tr>

<tr class="row-even"><td>Toggle major grids</td>

<td>g when mouse is over an axes</td>

</tr>

<tr class="row-odd"><td>Toggle minor grids</td>

<td>G when mouse is over an axes</td>

</tr>

<tr class="row-even"><td>Toggle x axis scale (log/linear)</td>

<td>L or k when mouse is over an axes</td>

</tr>

<tr class="row-odd"><td>Toggle y axis scale (log/linear)</td>

<td>l when mouse is over an axes</td>

</tr>

</tbody>

</table>

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">matplotlib.pyplot</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">matplotlib/examples/user_interfaces</code> directory. Here is some

example code for GTK+ 3:

<div class="highlight-default notranslate"><div class="highlight"><pre>import gi

gi.require_version('Gtk', '3.0')

from gi.repository import Gtk

from matplotlib.figure import Figure

from matplotlib.backends.backend_gtk3agg import FigureCanvas

from matplotlib.backends.backend_gtk3 import (

NavigationToolbar2GTK3 as NavigationToolbar)

win = Gtk.Window()

win.connect("destroy", lambda x: Gtk.main_quit())

win.set_default_size(400,300)

win.set_title("Embedding in GTK")

vbox = Gtk.VBox()

win.add(vbox)

fig = Figure(figsize=(5,4), dpi=100)

ax = fig.add_subplot(111)

ax.plot([1,2,3])

canvas = FigureCanvas(fig) # a Gtk.DrawingArea

vbox.pack_start(canvas, True, True, 0)

toolbar = NavigationToolbar(canvas, win)

vbox.pack_start(toolbar, False, False, 0)

win.show_all()

Gtk.main()

</pre></div>

</div>

</div>

Last updated on Jan 05, 2020.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.

Doc version v3.1.1-79-g90d53b526.

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

navigation_toolbar.html

Latest commit

History

navigation_toolbar.html

File metadata and controls