matplotlib.github.com/3.10.6/index.html at main · matplotlib/matplotlib.github.com

History

821 lines (608 loc) · 33 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

<!DOCTYPE html>

<head>

<title>Matplotlib documentation — Matplotlib 3.10.6 documentation</title>

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

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

</script>

DOCUMENTATION_OPTIONS.theme_version = '0.15.4';

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

DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.10.6';

DOCUMENTATION_OPTIONS.show_version_warning_banner = true;

</script>

title="Search within Matplotlib 3.10.6 documentation"

href="_static/opensearch.xml"/>

</head>

<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>

<input type="checkbox"

class="sidebar-toggle"

id="pst-primary-sidebar-checkbox"/>

<input type="checkbox"

class="sidebar-toggle"

id="pst-secondary-sidebar-checkbox"/>

<form class="bd-search d-flex align-items-center"

action="search.html"

method="get">

<input type="search"

class="form-control"

name="q"

id="search-input"

placeholder="Search the docs ..."

aria-label="Search the docs ..."

autocomplete="off"

autocorrect="off"

autocapitalize="off"

spellcheck="false"/>

</form></div>

</div>

</div>

</button>

</a></div>

</div>

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

</li>

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

</li>

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

</li>

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

</li>

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

</li>

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

</li>

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

</li>

</ul></div>

</div>

document.write(`

</button>

`);

</script>

</div>

document.write(`

</button>

`);

</script></div>

document.write(`

<button id="pst-version-switcher-button-2"

type="button"

class="version-switcher__button btn btn-sm dropdown-toggle"

data-bs-toggle="dropdown"

aria-haspopup="listbox"

aria-controls="pst-version-switcher-list-2"

aria-label="Version switcher list"

Choose version

</button>

<div id="pst-version-switcher-list-2"

class="version-switcher__menu dropdown-menu list-group-flush py-0"

role="listbox" aria-labelledby="pst-version-switcher-button-2">

</div>

`);

</script></div>

<div class="navbar-item"><ul class="navbar-icon-links"

aria-label="Icon Links">

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

</li>

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

</li>

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

</li>

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

</li>

</ul></div>

</div>

document.write(`

</button>

`);

</script>

</div>

</button>

</div>

</header>

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

</li>

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

</li>

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

</li>

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

</li>

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

</li>

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

</li>

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

</li>

</ul></div>

</div>

document.write(`

</button>

`);

</script></div>

document.write(`

<button id="pst-version-switcher-button-3"

type="button"

class="version-switcher__button btn btn-sm dropdown-toggle"

data-bs-toggle="dropdown"

aria-haspopup="listbox"

aria-controls="pst-version-switcher-list-3"

aria-label="Version switcher list"

Choose version

</button>

<div id="pst-version-switcher-list-3"

class="version-switcher__menu dropdown-menu list-group-flush py-0"

role="listbox" aria-labelledby="pst-version-switcher-button-3">

</div>

`);

</script></div>

<div class="navbar-item"><ul class="navbar-icon-links"

aria-label="Icon Links">

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

</li>

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

</li>

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

</li>

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

</li>

</ul></div>

</div>

<h3>Cheatsheets</h3>

<img src="_static/mpl_cheatsheet1.png"

alt="Matplotlib cheatsheets"

srcset="_static/mpl_cheatsheet1.png 1x, _static/mpl_cheatsheet1_2x.png 2x"/>

</a>

</div></div>

Support Matplotlib

</a>

</div></div>

</div>

</div>

</div>

<span id="module-matplotlib"></span><h1>Matplotlib 3.10.6 documentation<a class="headerlink" href="#matplotlib-release-documentation" title="Link to this heading">#</a></h1>

<p>Matplotlib is a comprehensive library for creating static, animated,

and interactive visualizations.</p>

<h2>Install<a class="headerlink" href="#install" title="Link to this heading">#</a></h2>

pip</label><div class="sd-tab-content docutils">

<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>matplotlib

</pre></div>

</div>

conda</label><div class="sd-tab-content docutils">

<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>matplotlib

</pre></div>

</div>

pixi</label><div class="sd-tab-content docutils">

<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pixi<span class="w"> </span>add<span class="w"> </span>matplotlib

</pre></div>

</div>

uv</label><div class="sd-tab-content docutils">

<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>uv<span class="w"> </span>add<span class="w"> </span>matplotlib

</pre></div>

</div>

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

<p>uv usually installs its own versions of Python from the

python-build-standalone project, and only recent versions of those

Python builds (August 2025) work properly with the <code class="docutils literal notranslate"><span class="pre">tkagg</span></code> backend

for displaying plots in a window. Please make sure you are using uv

0.8.7 or newer (update with e.g. <code class="docutils literal notranslate"><span class="pre">uv</span> <span class="pre">self</span> <span class="pre">update</span></code>) and that your

bundled Python installs are up to date (with <code class="docutils literal notranslate"><span class="pre">uv</span> <span class="pre">python</span> <span class="pre">upgrade</span>

<span class="pre">--reinstall</span></code>). Alternatively, you can use one of the other

<a class="reference internal" href="install/dependencies.html#optional-dependencies"><span class="std std-ref">supported GUI frameworks</span></a>, e.g.</p>

<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>uv<span class="w"> </span>add<span class="w"> </span>matplotlib<span class="w"> </span>pyside6

</pre></div>

</div>

other</label><div class="sd-tab-content docutils">

<p><a class="reference internal" href="install/index.html#install-official"><span class="std std-ref">Install an official release</span></a></p>

<p><a class="reference internal" href="install/index.html#install-third-party"><span class="std std-ref">Third-party distributions</span></a></p>

<p><a class="reference internal" href="install/index.html#install-nightly-build"><span class="std std-ref">Install a nightly build</span></a></p>

<p><a class="reference internal" href="install/index.html#install-source"><span class="std std-ref">Install from source</span></a></p>

</div>

</div>

</section>

<h2>Learn<a class="headerlink" href="#learn" title="Link to this heading">#</a></h2>

<p class="sd-card-text"><strong>How to use Matplotlib?</strong></p>

</div>

<ul>

<li class="toctree-l1"><a class="reference internal" href="users/explain/quick_start.html">Quick start guide</a></li>

<li class="toctree-l1"><a class="reference internal" href="users/index.html">User guide</a></li>

<li class="toctree-l1"><a class="reference internal" href="tutorials/index.html">Tutorials</a></li>

<li class="toctree-l1"><a class="reference internal" href="users/faq.html">Frequently Asked Questions</a></li>

</ul>

</div>

<p class="sd-card-text"><strong>What can Matplotlib do?</strong></p>

</div>

<ul>

<li class="toctree-l1"><a class="reference internal" href="plot_types/index.html">Plot types</a></li>

<li class="toctree-l1"><a class="reference internal" href="gallery/index.html">Examples</a></li>

</ul>

</div>

<p class="sd-card-text"><strong>Reference</strong></p>

</div>

<ul>

<li class="toctree-l1"><a class="reference internal" href="api/index.html">API reference</a></li>

<li class="toctree-l1"><a class="reference internal" href="api/figure_api.html">Figure methods</a></li>

<li class="toctree-l1"><a class="reference internal" href="api/axes_api.html">Plotting methods</a></li>

</ul>

</div>

<p class="sd-card-text">Top-level interfaces to create:</p>

<li><p class="sd-card-text">figures: <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></p></li>

<li><p class="sd-card-text">subplots: <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>, <a class="reference internal" href="api/_as_gen/matplotlib.pyplot.subplot_mosaic.html#matplotlib.pyplot.subplot_mosaic" title="matplotlib.pyplot.subplot_mosaic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyplot.subplot_mosaic</span></code></a></p></li>

</ul>

</div>

</section>

<h2>Community<a class="headerlink" href="#community" title="Link to this heading">#</a></h2>

<ul>

<li class="toctree-l1"><a class="reference internal" href="users/resources/index.html">External resources</a><ul>

<li class="toctree-l2"><a class="reference internal" href="users/resources/index.html#books-chapters-and-articles">Books, chapters and articles</a></li>

<li class="toctree-l2"><a class="reference internal" href="users/resources/index.html#videos">Videos</a></li>

<li class="toctree-l2"><a class="reference internal" href="users/resources/index.html#tutorials">Tutorials</a></li>

<li class="toctree-l2"><a class="reference internal" href="users/resources/index.html#galleries">Galleries</a></li>

</ul>

</li>

</ul>

</div>

<p><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-link-external sd-text-info" viewBox="0 0 16 16" aria-hidden="true"><path d="M3.75 2h3.5a.75.75 0 0 1 0 1.5h-3.5a.25.25 0 0 0-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 0 0 .25-.25v-3.5a.75.75 0 0 1 1.5 0v3.5A1.75 1.75 0 0 1 12.25 14h-8.5A1.75 1.75 0 0 1 2 12.25v-8.5C2 2.784 2.784 2 3.75 2Zm6.854-1h4.146a.25.25 0 0 1 .25.25v4.146a.25.25 0 0 1-.427.177L13.03 4.03 9.28 7.78a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042l3.75-3.75-1.543-1.543A.25.25 0 0 1 10.604 1Z"></path></svg> <a class="reference external" href="https://matplotlib.org/mpl-third-party/">Third-party packages</a>,</p>

<p>provide custom, domain specific, and experimental features, including

styles, colors, more plot types and backends, and alternative

interfaces.</p>

</div>

</section>

<p>Learn about new features and API changes.</p>

</div>

<ul>

<li class="toctree-l1"><a class="reference internal" href="users/release_notes.html">Release notes</a></li>

</ul>

</div>

</section>

<h2>Contribute<a class="headerlink" href="#contribute" title="Link to this heading">#</a></h2>

<p>Matplotlib is a community project maintained for and by its users. See

<a class="reference internal" href="devel/index.html#developers-guide-index"><span class="std std-ref">Contribute</span></a> for the many ways you can help!</p>

</div>

<ul>

<li class="toctree-l1"><a class="reference internal" href="devel/index.html">Contribute</a><ul>

<li class="toctree-l2"><a class="reference internal" href="devel/index.html#github-issue-tracker">GitHub issue tracker</a></li>

<li class="toctree-l2"><a class="reference internal" href="devel/index.html#contributing-guide">Contributing guide</a></li>

<li class="toctree-l2"><a class="reference internal" href="devel/index.html#development-workflow">Development workflow</a></li>

<li class="toctree-l2"><a class="reference internal" href="devel/index.html#policies-and-guidelines">Policies and guidelines</a></li>

</ul>

</li>

</ul>

</div>

</section>

<h2>About us<a class="headerlink" href="#about-us" title="Link to this heading">#</a></h2>

<p>Matplotlib was created by neurobiologist John Hunter to work with EEG

data. It grew to be used and developed by many people in many

different fields. John's goal was that Matplotlib make easy things easy

and hard things possible.</p>

</div>

<ul>

<li class="toctree-l1"><a class="reference internal" href="project/index.html">Project information</a><ul>

<li class="toctree-l2"><a class="reference internal" href="project/mission.html">Mission Statement</a></li>

<li class="toctree-l2"><a class="reference internal" href="project/history.html">History</a></li>

<li class="toctree-l2"><a class="reference internal" href="project/code_of_conduct.html">Code of Conduct</a></li>

<li class="toctree-l2"><a class="reference internal" href="project/citing.html">Citing Matplotlib</a></li>

<li class="toctree-l2"><a class="reference internal" href="project/license.html">License</a></li>

<li class="toctree-l2"><a class="reference internal" href="project/credits.html">Credits</a></li>

</ul>

</li>

</ul>

</div>

</section>

</article>

</div>

<div

id="pst-page-navigation-heading-2"

class="page-toc tocsection onthispage">

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

</div>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#install">Install</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#learn">Learn</a><ul class="nav section-nav flex-column">

</ul>

</li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#community">Community</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#contribute">Contribute</a></li>

<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#about-us">About us</a></li>

</ul>

</nav></div>

</div></div>

</div>

</footer>

</main>

</div>

<br/>

</p>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

<br/>

</p>

</div>

Built from v3.10.6-2-g22c649b6a4.

<br/>

</p>

</div>

Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.4.

</p></div>

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls