matplotlib.github.com/3.7.4/users/explain/interactive.html at main · matplotlib/matplotlib.github.com

History

822 lines (635 loc) · 48.3 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

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

<!DOCTYPE html>

<head>

<title>Interactive figures — Matplotlib 3.7.4 documentation</title>

document.documentElement.dataset.mode = localStorage.getItem("mode") || "";

document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";

</script>

DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.7.4-2-g03947d07cf';

DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.7.4';

</script>

title="Search within Matplotlib 3.7.4 documentation"

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

</head>

<a class="skip-link" href="#main-content">Skip to main content</a>

</form>

</div>

</label>

</a>

</div>

<a class="reference internal nav-link" href="../../plot_types/index.html">Plot types</a>

</li>

<a class="reference internal nav-link" href="../../gallery/index.html">Examples</a>

</li>

<a class="reference internal nav-link" href="../../tutorials/index.html">Tutorials</a>

</li>

<a class="reference internal nav-link" href="../../api/index.html">Reference</a>

</li>

<a class="reference internal nav-link" href="../index.html">User guide</a>

</li>

<a class="reference internal nav-link" href="../../devel/index.html">Develop</a>

</li>

<a class="reference internal nav-link" href="../release_notes.html">Releases</a>

</li>

</ul>

</div>

</button>

</div>

</button>

</div>

stable

</button>

</div>

<label class="sr-only">Gitter</label></a>

</li>

<label class="sr-only">Discourse</label></a>

</li>

<label class="sr-only">GitHub</label></a>

</li>

<label class="sr-only">Twitter</label></a>

</li>

</ul>

</div>

</button>

</div>

</label>

</div>

</nav>

<a class="reference internal nav-link" href="../../plot_types/index.html">Plot types</a>

</li>

<a class="reference internal nav-link" href="../../gallery/index.html">Examples</a>

</li>

<a class="reference internal nav-link" href="../../tutorials/index.html">Tutorials</a>

</li>

<a class="reference internal nav-link" href="../../api/index.html">Reference</a>

</li>

<a class="reference internal nav-link" href="../index.html">User guide</a>

</li>

<a class="reference internal nav-link" href="../../devel/index.html">Develop</a>

</li>

<a class="reference internal nav-link" href="../release_notes.html">Releases</a>

</li>

</ul>

</div>

</button>

</div>

stable

</button>

</div>

<label class="sr-only">Gitter</label></a>

</li>

<label class="sr-only">Discourse</label></a>

</li>

<label class="sr-only">GitHub</label></a>

</li>

<label class="sr-only">Twitter</label></a>

</li>

</ul>

</div>

Section Navigation

</p>

<li class="toctree-l1"><a class="reference internal" href="api_interfaces.html">Matplotlib Application Interfaces (APIs)</a></li>

<li class="toctree-l1"><a class="reference internal" href="figures.html">Creating, viewing, and saving Matplotlib Figures</a></li>

<li class="toctree-l1"><a class="reference internal" href="backends.html">Backends</a></li>

<li class="toctree-l1"><a class="reference internal" href="writing_a_backend_pyplot_interface.html">Writing a backend -- the pyplot interface</a></li>

<li class="toctree-l1 current active"><a class="current reference internal" href="#">Interactive figures</a></li>

<li class="toctree-l1"><a class="reference internal" href="fonts.html">Fonts in Matplotlib</a></li>

<li class="toctree-l1"><a class="reference internal" href="event_handling.html">Event handling and picking</a></li>

<li class="toctree-l1"><a class="reference internal" href="performance.html">Performance</a></li>

<li class="toctree-l1"><a class="reference internal" href="interactive_guide.html">Interactive figures and asynchronous programming</a></li>

</ul>

</div>

</nav>

</div>

</div>

</div>

</div>

<span id="mpl-shell"></span><span id="id1"></span><h1>Interactive figures<a class="headerlink" href="#interactive-figures" title="Link to this heading">#</a></h1>

<p>When working with data, interactivity can be invaluable. The pan/zoom and

mouse-location tools built into the Matplotlib GUI windows are often sufficient, but

you can also use the event system to build customized data exploration tools.</p>

<p><a class="reference internal" href="figures.html#figure-explanation"><span class="std std-ref">Creating, viewing, and saving Matplotlib Figures</span></a>.</p>

</div>

<p>Matplotlib ships with <a class="reference internal" href="backends.html#what-is-a-backend"><span class="std std-ref">backends</span></a> binding to

several GUI toolkits (Qt, Tk, Wx, GTK, macOS, JavaScript) and third party

packages provide bindings to <a class="reference external" href="https://github.com/kivy-garden/garden.matplotlib">kivy</a> and <a class="reference external" href="https://matplotlib.org/ipympl">Jupyter Lab</a>. For the figures to be responsive to

mouse, keyboard, and paint events, the GUI event loop needs to be integrated

with an interactive prompt. We recommend using IPython (see <a class="reference internal" href="#ipython-pylab"><span class="std std-ref">below</span></a>).</p>

<p>The <a class="reference internal" href="../../api/pyplot_summary.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot</span></code></a> module provides functions for explicitly creating figures

that include interactive tools, a toolbar, a tool-tip, and

<a class="reference internal" href="#key-event-handling"><span class="std std-ref">key bindings</span></a>:</p>

<dt><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.figure</span></code></a></dt><dd><p>Creates a new empty <a class="reference internal" href="../../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> or selects an existing figure</p>

</dd>

<dt><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="matplotlib.pyplot.subplots"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplots</span></code></a></dt><dd><p>Creates a new <a class="reference internal" href="../../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> and fills it with a grid of <a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a></p>

</dd>

</dl>

<p><a class="reference internal" href="../../api/pyplot_summary.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot</span></code></a> has a notion of "The Current Figure" which can be accessed

through <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.gcf.html#matplotlib.pyplot.gcf" title="matplotlib.pyplot.gcf"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.gcf</span></code></a> and a notion of "The Current Axes" accessed

through <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.gca.html#matplotlib.pyplot.gca" title="matplotlib.pyplot.gca"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.gca</span></code></a>. Almost all of the functions in <a class="reference internal" href="../../api/pyplot_summary.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot</span></code></a> pass

through the current <a class="reference internal" href="../../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> / <a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axes</span></code></a> (or create one) as

appropriate.</p>

<p>Matplotlib keeps a reference to all of the open figures

created via <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.figure</span></code></a> or <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="matplotlib.pyplot.subplots"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplots</span></code></a> so that the figures will not be garbage

collected. <a class="reference internal" href="../../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a>s can be closed and deregistered from <a class="reference internal" href="../../api/pyplot_summary.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot</span></code></a> individually via

<a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.close.html#matplotlib.pyplot.close" title="matplotlib.pyplot.close"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.close</span></code></a>; all open <a class="reference internal" href="../../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a>s can be closed via <code class="docutils literal notranslate"><span class="pre">plt.close('all')</span></code>.</p>

<p>For more discussion of Matplotlib's event system and integrated event loops:</p>

<li><p><a class="reference internal" href="interactive_guide.html#interactive-figures-and-eventloops"><span class="std std-ref">Interactive figures and asynchronous programming</span></a></p></li>

<li><p><a class="reference internal" href="event_handling.html#event-handling-tutorial"><span class="std std-ref">Event handling and picking</span></a></p></li>

</ul>

</div>

<span id="ipython-pylab"></span><h2>IPython integration<a class="headerlink" href="#ipython-integration" title="Link to this heading">#</a></h2>

<p>We recommend using IPython for an interactive shell. In addition to

all of its features (improved tab-completion, magics, multiline editing, etc),

it also ensures that the GUI toolkit event loop is properly integrated

with the command line (see <a class="reference internal" href="interactive_guide.html#cp-integration"><span class="std std-ref">Command prompt integration</span></a>).</p>

<p>In this example, we create and modify a figure via an IPython prompt.

The figure displays in a QtAgg GUI window. To configure the integration

and enable <a class="reference internal" href="#controlling-interactive"><span class="std std-ref">interactive mode</span></a> use the

<code class="docutils literal notranslate"><span class="pre">%matplotlib</span></code> magic:</p>

<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [1]: </span><span class="o">%</span><span class="k">matplotlib</span>

<span class="go">Using matplotlib backend: QtAgg</span>

<span class="gp">In [2]: </span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>

</pre></div>

</div>

<p>Create a new figure window:</p>

<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [3]: </span><span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span>

</pre></div>

</div>

<p>Add a line plot of the data to the window:</p>

<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [4]: </span><span class="n">ln</span><span class="p">,</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">plot</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">5</span><span class="p">))</span>

</pre></div>

</div>

<p>Change the color of the line from blue to orange:</p>

<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [5]: </span><span class="n">ln</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s1">'orange'</span><span class="p">)</span>

</pre></div>

</div>

<p>If you wish to disable automatic redrawing of the plot:</p>

</pre></div>

</div>

<p>If you wish to re-enable automatic redrawing of the plot:</p>

</pre></div>

</div>

<p>In recent versions of <code class="docutils literal notranslate"><span class="pre">Matplotlib</span></code> and <code class="docutils literal notranslate"><span class="pre">IPython</span></code>, it is

sufficient to import <a class="reference internal" href="../../api/pyplot_summary.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pyplot</span></code></a> and call <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.ion.html#matplotlib.pyplot.ion" title="matplotlib.pyplot.ion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ion</span></code></a>.

Using the <code class="docutils literal notranslate"><span class="pre">%</span></code> magic is guaranteed to work in all versions of Matplotlib and IPython.</p>

</section>

<span id="controlling-interactive"></span><h2>Interactive mode<a class="headerlink" href="#interactive-mode" title="Link to this heading">#</a></h2>

<tbody>

<tr class="row-odd"><td><p><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.ion.html#matplotlib.pyplot.ion" title="matplotlib.pyplot.ion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ion</span></code></a></p></td>

<td><p>Enable interactive mode.</p></td>

</tr>

<tr class="row-even"><td><p><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.ioff.html#matplotlib.pyplot.ioff" title="matplotlib.pyplot.ioff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ioff</span></code></a></p></td>

<td><p>Disable interactive mode.</p></td>

</tr>

<tr class="row-odd"><td><p><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.isinteractive.html#matplotlib.pyplot.isinteractive" title="matplotlib.pyplot.isinteractive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.isinteractive</span></code></a></p></td>

<td><p>Return whether plots are updated after every plotting command.</p></td>

</tr>

</tbody>

</table>

<tbody>

<tr class="row-odd"><td><p><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show</span></code></a></p></td>

<td><p>Display all open figures.</p></td>

</tr>

<tr class="row-even"><td><p><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.pause.html#matplotlib.pyplot.pause" title="matplotlib.pyplot.pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.pause</span></code></a></p></td>

<td><p>Run the GUI event loop for <em>interval</em> seconds.</p></td>

</tr>

</tbody>

</table>

<p>Interactive mode controls:</p>

<li><p>whether created figures are automatically shown</p></li>

<li><p>whether changes to artists automatically trigger re-drawing existing figures</p></li>

<li><p>when <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show()</span></code></a> returns if given no arguments: immediately, or after all of the figures have been closed</p></li>

</ul>

<p>If in interactive mode:</p>

<li><p>newly created figures will be displayed immediately</p></li>

<li><p>figures will automatically redraw when elements are changed</p></li>

<li><p><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show()</span></code></a> displays the figures and immediately returns</p></li>

</ul>

<p>If not in interactive mode:</p>

<li><p>newly created figures and changes to figures are not displayed until</p>

<ul>

<li><p><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.pause.html#matplotlib.pyplot.pause" title="matplotlib.pyplot.pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.pause()</span></code></a> is called</p></li>

<li><p><a class="reference internal" href="../../api/backend_bases_api.html#matplotlib.backend_bases.FigureCanvasBase.flush_events" title="matplotlib.backend_bases.FigureCanvasBase.flush_events"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FigureCanvasBase.flush_events()</span></code></a> is called</p></li>

</ul>

</li>

<li><p><a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show()</span></code></a> runs the GUI event loop and does not return until all the plot windows are closed</p></li>

</ul>

<p>If you are in non-interactive mode (or created figures while in

non-interactive mode) you may need to explicitly call <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="matplotlib.pyplot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.show</span></code></a>

to display the windows on your screen. If you only want to run the

GUI event loop for a fixed amount of time, you can use <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.pause.html#matplotlib.pyplot.pause" title="matplotlib.pyplot.pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.pause</span></code></a>.

This will block the progress of your code as if you had called

<a class="reference external" href="https://docs.python.org/3/library/time.html#time.sleep" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time.sleep</span></code></a>, ensure the current window is shown and re-drawn if needed,

and run the GUI event loop for the specified period of time.</p>

<p>The GUI event loop being integrated with your command prompt and

the figures being in interactive mode are independent of each other.

If you try to use <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.ion.html#matplotlib.pyplot.ion" title="matplotlib.pyplot.ion"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.ion</span></code></a> without arranging for the event-loop integration,

your figures will appear but will not be interactive while the prompt is waiting for input.

You will not be able to pan/zoom and the figure may not even render

(the window might appear black, transparent, or as a snapshot of the

desktop under it). Conversely, if you configure the event loop

integration, displayed figures will be responsive while waiting for input

at the prompt, regardless of pyplot's "interactive mode".</p>

<p>No matter what combination of interactive mode setting and event loop integration,

figures will be responsive if you use <code class="docutils literal notranslate"><span class="pre">pyplot.show(block=True)</span></code>, <a class="reference internal" href="../../api/_as_gen/matplotlib.pyplot.pause.html#matplotlib.pyplot.pause" title="matplotlib.pyplot.pause"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.pause</span></code></a>, or run

the GUI main loop in some other way.</p>

<p class="admonition-title">Warning</p>

<p>Using <a class="reference internal" href="../../api/figure_api.html#matplotlib.figure.Figure.show" title="matplotlib.figure.Figure.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure.show</span></code></a> it is possible to display a figure on

the screen without starting the event loop and without being in

interactive mode. This may work (depending on the GUI toolkit) but

will likely result in a non-responsive figure.</p>

</div>

</section>

<span id="navigation-toolbar"></span><h2>Default UI<a class="headerlink" href="#default-ui" title="Link to this heading">#</a></h2>

<p>The windows created by <a class="reference internal" href="../../api/pyplot_summary.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pyplot</span></code></a> have an interactive toolbar with navigation

buttons and a readout of the data values the cursor is pointing at. A number of

helpful keybindings are registered by default.</p>

<span id="key-event-handling"></span><h3>Navigation keyboard shortcuts<a class="headerlink" href="#navigation-keyboard-shortcuts" title="Link to this heading">#</a></h3>

<p>The following table holds all the default keys, which can be

overwritten by use of your <a class="reference internal" href="../../tutorials/introductory/customizing.html"><span class="doc">matplotlibrc</span></a>.</p>

<thead>

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

<th class="head"><p>Default key binding and rcParam</p></th>

</tr>

</thead>

<tbody>

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

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.home#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.home"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['h',</span> <span class="pre">'r',</span> <span class="pre">'home']</span></code>)</p></td>

</tr>

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.back#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.back"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['left',</span> <span class="pre">'c',</span> <span class="pre">'backspace',</span> <span class="pre">'MouseButton.BACK']</span></code>)</p></td>

</tr>

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

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.forward#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.forward"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['right',</span> <span class="pre">'v',</span> <span class="pre">'MouseButton.FORWARD']</span></code>)</p></td>

</tr>

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.pan#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.pan"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['p']</span></code>)</p></td>

</tr>

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.zoom#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.zoom"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['o']</span></code>)</p></td>

</tr>

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.save#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.save"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['s',</span> <span class="pre">'ctrl+s']</span></code>)</p></td>

</tr>

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

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.fullscreen#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.fullscreen"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['f',</span> <span class="pre">'ctrl+f']</span></code>)</p></td>

</tr>

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

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.grid#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.grid"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['g']</span></code>)</p></td>

</tr>

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

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.grid_minor#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.grid_minor"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['G']</span></code>)</p></td>

</tr>

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

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.xscale#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.xscale"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['k',</span> <span class="pre">'L']</span></code>)</p></td>

</tr>

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

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.yscale#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.yscale"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['l']</span></code>)</p></td>

</tr>

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

<td><p><code class="docutils literal notranslate"><a class="reference internal" href="../../tutorials/introductory/customizing.html?highlight=keymap.quit#matplotlibrc-sample"><span class="std std-ref"><span class="pre">rcParams["keymap.quit"]</span></span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">['ctrl+w',</span> <span class="pre">'cmd+w',</span> <span class="pre">'q']</span></code>)</p></td>

</tr>

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

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

</tr>

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

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

</tr>

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

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

</tr>

</tbody>

</table>

</section>

<span id="other-shells"></span><h2>Other Python prompts<a class="headerlink" href="#other-python-prompts" title="Link to this heading">#</a></h2>

<p>Interactive mode works in the default Python prompt:</p>

<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>

</pre></div>

</div>

<p>however this does not ensure that the event hook is properly installed

and your figures may not be responsive. Please consult the

documentation of your GUI toolkit for details.</p>

<span id="id2"></span><h3>Jupyter Notebooks / JupyterLab<a class="headerlink" href="#jupyter-notebooks-jupyterlab" title="Link to this heading">#</a></h3>

<p>To get the interactive functionality described here, you must be

using an interactive backend. The default backend in notebooks,

the inline backend, is not. <code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_inline</span></code>

renders the figure once and inserts a static image into the

notebook when the cell is executed. Because the images are static, they

can not be panned / zoomed, take user input, or be updated from other

cells.</p>

</div>

<p>To get interactive figures in the 'classic' notebook or Jupyter lab,

use the <a class="reference external" href="https://matplotlib.org/ipympl">ipympl</a> backend

(must be installed separately) which uses the <strong>ipywidget</strong> framework.

If <code class="docutils literal notranslate"><span class="pre">ipympl</span></code> is installed use the magic:</p>

<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="k">matplotlib</span> widget

</pre></div>

</div>

<p>to select and enable it.</p>

<p>If you only need to use the classic notebook, you can use</p>

<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="k">matplotlib</span> notebook

</pre></div>

</div>

<p>which uses the <a class="reference internal" href="../../api/backend_nbagg_api.html#module-matplotlib.backends.backend_nbagg" title="matplotlib.backends.backend_nbagg"><code class="xref py py-obj docutils literal notranslate"><span class="pre">backend_nbagg</span></code></a> backend provided by Matplotlib;

however, nbagg does not work in Jupyter Lab.</p>

<h4>GUIs + Jupyter<a class="headerlink" href="#guis-jupyter" title="Link to this heading">#</a></h4>

<p>You can also use one of the non-<code class="docutils literal notranslate"><span class="pre">ipympl</span></code> GUI backends in a Jupyter Notebook.

If you are running your Jupyter kernel locally, the GUI window will spawn on

your desktop adjacent to your web browser. If you run your notebook on a remote server,

the kernel will try to open the GUI window on the remote computer. Unless you have

arranged to forward the xserver back to your desktop, you will not be able to

see or interact with the window. It may also raise an exception.</p>

</section>

<h3>PyCharm, Spyder, and VSCode<a class="headerlink" href="#pycharm-spyder-and-vscode" title="Link to this heading">#</a></h3>

<p>Many IDEs have built-in integration with Matplotlib, please consult their

documentation for configuration details.</p>

</section>

</article>

</div>

<i class="fa-solid fa-list"></i> On this page

</div>

IPython integration

</a>

</li>

Interactive mode

</a>

</li>

Default UI

</a>

Navigation keyboard shortcuts

</a>

</li>

</ul>

</li>

Other Python prompts

</a>

Jupyter Notebooks / JupyterLab

</a>

GUIs + Jupyter

</a>

</li>

</ul>

</li>

PyCharm, Spyder, and VSCode

</a>

</li>

</ul>

</li>

</ul>

</nav>

</div>

</div>

</footer>

</main>

</div>

</p>

</div>

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br>

</p>

</div>

Built from v3.7.4-2-g03947d07cf.

<br/>

</p>

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

interactive.html

Latest commit

History

interactive.html

File metadata and controls