matplotlib.github.com/3.3.1/_modules/matplotlib/pyplot.html at main · matplotlib/matplotlib.github.com

History

3466 lines (2723 loc) · 390 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

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

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

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

<head>

<title>matplotlib.pyplot — Matplotlib 3.3.1 documentation</title>

title="Search within Matplotlib 3.3.1 documentation"

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

</head><body>

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

<!--

</div>

-->

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

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

</div>

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

</form>

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

<li><a href="../../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

<li class="nav-item nav-item-this"><a href="">matplotlib.pyplot</a></li>

</ul>

</div>

<h3>Related Topics</h3>

<ul>

<li><a href="../../contents.html">Documentation overview</a><ul>

<li><a href="../index.html">Module code</a><ul>

<li><a href="../matplotlib.html">matplotlib</a><ul>

</ul></li>

</ul>

</div>

<h1>Source code for matplotlib.pyplot</h1><div class="highlight"><pre>

# Note: The first part of this file can be modified in place, but the latter

# part is autogenerated by the boilerplate.py script.

"""

`matplotlib.pyplot` is a state-based interface to matplotlib. It provides

a MATLAB-like way of plotting.

pyplot is mainly intended for interactive plots and simple cases of

programmatic plot generation::

import numpy as np

import matplotlib.pyplot as plt

x = np.arange(0, 5, 0.1)

y = np.sin(x)

plt.plot(x, y)

The object-oriented API is recommended for more complex plots.

"""

import functools

import importlib

import inspect

import logging

from numbers import Number

import re

import sys

import time

try:

import threading

except ImportError:

import dummy_threading as threading

from cycler import cycler

import matplotlib

import matplotlib.colorbar

import matplotlib.image

from matplotlib import rcsetup, style

from matplotlib import _pylab_helpers, interactive

from matplotlib import cbook

from matplotlib import docstring

from matplotlib.backend_bases import FigureCanvasBase, MouseButton

from matplotlib.figure import Figure, figaspect

from matplotlib.gridspec import GridSpec

from matplotlib import rcParams, rcParamsDefault, get_backend, rcParamsOrig

from matplotlib.rcsetup import interactive_bk as _interactive_bk

from matplotlib.artist import Artist

from matplotlib.axes import Axes, Subplot

from matplotlib.projections import PolarAxes

from matplotlib import mlab # for detrend_none, window_hanning

from matplotlib.scale import get_scale_names

from matplotlib import cm

from matplotlib.cm import get_cmap, register_cmap

import numpy as np

# We may not need the following imports here:

from matplotlib.colors import Normalize

from matplotlib.lines import Line2D

from matplotlib.text import Text, Annotation

from matplotlib.patches import Polygon, Rectangle, Circle, Arrow

from matplotlib.widgets import SubplotTool, Button, Slider, Widget

from .ticker import (

TickHelper, Formatter, FixedFormatter, NullFormatter, FuncFormatter,

FormatStrFormatter, ScalarFormatter, LogFormatter, LogFormatterExponent,

LogFormatterMathtext, Locator, IndexLocator, FixedLocator, NullLocator,

LinearLocator, LogLocator, AutoLocator, MultipleLocator, MaxNLocator)

_log = logging.getLogger(__name__)

_code_objs = {

cbook._rename_parameter:

cbook._rename_parameter("", "old", "new", lambda new: None).__code__,

cbook._make_keyword_only:

cbook._make_keyword_only("", "p", lambda p: None).__code__,

}

def _copy_docstring_and_deprecators(method, func=None):

if func is None:

return functools.partial(_copy_docstring_and_deprecators, method)

decorators = [docstring.copy(method)]

# Check whether the definition of *method* includes _rename_parameter or

# _make_keyword_only decorators; if so, propagate them to the pyplot

# wrapper as well.

while getattr(method, "__wrapped__", None) is not None:

for decorator_maker, code in _code_objs.items():

if method.__code__ is code:

kwargs = {

k: v.cell_contents

for k, v in zip(code.co_freevars, method.__closure__)}

assert kwargs["func"] is method.__wrapped__

kwargs.pop("func")

decorators.append(decorator_maker(**kwargs))

method = method.__wrapped__

for decorator in decorators[::-1]:

func = decorator(func)

return func

## Global ##

_IP_REGISTERED = None

_INSTALL_FIG_OBSERVER = False

<div class="viewcode-block" id="install_repl_displayhook"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.install_repl_displayhook.html#matplotlib.pyplot.install_repl_displayhook">[docs]</a>def install_repl_displayhook():

"""

Install a repl display hook so that any stale figure are automatically

redrawn when control is returned to the repl.

This works both with IPython and with vanilla python shells.

"""

global _IP_REGISTERED

global _INSTALL_FIG_OBSERVER

class _NotIPython(Exception):

pass

# see if we have IPython hooks around, if use them

try:

if 'IPython' in sys.modules:

from IPython import get_ipython

ip = get_ipython()

if ip is None:

raise _NotIPython()

if _IP_REGISTERED:

return

def post_execute():

if matplotlib.is_interactive():

draw_all()

# IPython >= 2

try:

ip.events.register('post_execute', post_execute)

except AttributeError:

# IPython 1.x

ip.register_post_execute(post_execute)

_IP_REGISTERED = post_execute

_INSTALL_FIG_OBSERVER = False

# trigger IPython's eventloop integration, if available

from IPython.core.pylabtools import backend2gui

ipython_gui_name = backend2gui.get(get_backend())

if ipython_gui_name:

ip.enable_gui(ipython_gui_name)

else:

_INSTALL_FIG_OBSERVER = True

# import failed or ipython is not running

except (ImportError, _NotIPython):

_INSTALL_FIG_OBSERVER = True</div>

def uninstall_repl_displayhook():

"""

Uninstall the matplotlib display hook.

.. warning::

Need IPython >= 2 for this to work. For IPython < 2 will raise a

``NotImplementedError``

.. warning::

If you are using vanilla python and have installed another

display hook this will reset ``sys.displayhook`` to what ever

function was there when matplotlib installed it's displayhook,

possibly discarding your changes.

"""

global _IP_REGISTERED

global _INSTALL_FIG_OBSERVER

if _IP_REGISTERED:

from IPython import get_ipython

ip = get_ipython()

try:

ip.events.unregister('post_execute', _IP_REGISTERED)

except AttributeError as err:

raise NotImplementedError("Can not unregister events "

"in IPython < 2.0") from err

_IP_REGISTERED = None

if _INSTALL_FIG_OBSERVER:

_INSTALL_FIG_OBSERVER = False

draw_all = _pylab_helpers.Gcf.draw_all

@functools.wraps(matplotlib.set_loglevel)

def set_loglevel(*args, **kwargs): # Ensure this appears in the pyplot docs.

return matplotlib.set_loglevel(*args, **kwargs)

<div class="viewcode-block" id="findobj"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.findobj.html#matplotlib.pyplot.findobj">[docs]</a>@_copy_docstring_and_deprecators(Artist.findobj)

def findobj(o=None, match=None, include_self=True):

if o is None:

o = gcf()

return o.findobj(match, include_self=include_self)</div>

def _get_required_interactive_framework(backend_mod):

return getattr(

backend_mod.FigureCanvas, "required_interactive_framework", None)

def switch_backend(newbackend):

"""

Close all open figures and set the Matplotlib backend.

The argument is case-insensitive. Switching to an interactive backend is

possible only if no event loop for another interactive backend has started.

Switching to and from non-interactive backends is always possible.

Parameters

----------

newbackend : str

The name of the backend to use.

"""

global _backend_mod

# make sure the init is pulled up so we can assign to it later

import matplotlib.backends

close("all")

if newbackend is rcsetup._auto_backend_sentinel:

# Don't try to fallback on the cairo-based backends as they each have

# an additional dependency (pycairo) over the agg-based backend, and

# are of worse quality.

for candidate in ["macosx", "qt5agg", "gtk3agg", "tkagg", "wxagg"]:

try:

switch_backend(candidate)

except ImportError:

continue

else:

rcParamsOrig['backend'] = candidate

return

else:

# Switching to Agg should always succeed; if it doesn't, let the

# exception propagate out.

switch_backend("agg")

rcParamsOrig["backend"] = "agg"

return

# Backends are implemented as modules, but "inherit" default method

# implementations from backend_bases._Backend. This is achieved by

# creating a "class" that inherits from backend_bases._Backend and whose

# body is filled with the module's globals.

backend_name = cbook._backend_module_name(newbackend)

class backend_mod(matplotlib.backend_bases._Backend):

locals().update(vars(importlib.import_module(backend_name)))

required_framework = _get_required_interactive_framework(backend_mod)

if required_framework is not None:

current_framework = cbook._get_running_interactive_framework()

if (current_framework and required_framework

and current_framework != required_framework):

raise ImportError(

"Cannot load backend {!r} which requires the {!r} interactive "

"framework, as {!r} is currently running".format(

newbackend, required_framework, current_framework))

_log.debug("Loaded backend %s version %s.",

newbackend, backend_mod.backend_version)

rcParams['backend'] = rcParamsDefault['backend'] = newbackend

_backend_mod = backend_mod

for func_name in ["new_figure_manager", "draw_if_interactive", "show"]:

globals()[func_name].__signature__ = inspect.signature(

getattr(backend_mod, func_name))

# Need to keep a global reference to the backend for compatibility reasons.

# See https://github.com/matplotlib/matplotlib/issues/6092

matplotlib.backends.backend = newbackend

def _warn_if_gui_out_of_main_thread():

if (_get_required_interactive_framework(_backend_mod)

and threading.current_thread() is not threading.main_thread()):

cbook._warn_external(

"Starting a Matplotlib GUI outside of the main thread will likely "

"fail.")

# This function's signature is rewritten upon backend-load by switch_backend.

<div class="viewcode-block" id="new_figure_manager"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.new_figure_manager.html#matplotlib.pyplot.new_figure_manager">[docs]</a>def new_figure_manager(*args, **kwargs):

"""Create a new figure manager instance."""

_warn_if_gui_out_of_main_thread()

return _backend_mod.new_figure_manager(*args, **kwargs)</div>

# This function's signature is rewritten upon backend-load by switch_backend.

def draw_if_interactive(*args, **kwargs):

return _backend_mod.draw_if_interactive(*args, **kwargs)

# This function's signature is rewritten upon backend-load by switch_backend.

def show(*args, **kwargs):

"""

Display all open figures.

In non-interactive mode, *block* defaults to True. All figures

will display and show will not return until all windows are closed.

If there are no figures, return immediately.

In interactive mode *block* defaults to False. This will ensure

that all of the figures are shown and this function immediately returns.

Parameters

----------

block : bool, optional

If `True` block and run the GUI main loop until all windows

are closed.

If `False` ensure that all windows are displayed and return

immediately. In this case, you are responsible for ensuring

that the event loop is running to have responsive figures.

See Also

--------

ion : enable interactive mode

ioff : disable interactive mode

"""

_warn_if_gui_out_of_main_thread()

return _backend_mod.show(*args, **kwargs)

<div class="viewcode-block" id="isinteractive"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.isinteractive.html#matplotlib.pyplot.isinteractive">[docs]</a>def isinteractive():

"""

Return if pyplot is in "interactive mode" or not.

If in interactive mode then:

- newly created figures will be shown immediately

- figures will automatically redraw on change

- `.pyplot.show` will not block by default

If not in interactive mode then:

- newly created figures and changes to figures will

not be reflected until explicitly asked to be

- `.pyplot.show` will block by default

See Also

--------

ion : enable interactive mode

ioff : disable interactive mode

show : show windows (and maybe block)

pause : show windows, run GUI event loop, and block for a time

"""

return matplotlib.is_interactive()</div>

<div class="viewcode-block" id="ioff"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.ioff.html#matplotlib.pyplot.ioff">[docs]</a>def ioff():

"""

Turn the interactive mode off.

See Also

--------

ion : enable interactive mode

isinteractive : query current state

show : show windows (and maybe block)

pause : show windows, run GUI event loop, and block for a time

"""

matplotlib.interactive(False)

uninstall_repl_displayhook()</div>

<div class="viewcode-block" id="ion"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.ion.html#matplotlib.pyplot.ion">[docs]</a>def ion():

"""

Turn the interactive mode on.

See Also

--------

ioff : disable interactive mode

isinteractive : query current state

show : show windows (and maybe block)

pause : show windows, run GUI event loop, and block for a time

"""

matplotlib.interactive(True)

install_repl_displayhook()</div>

<div class="viewcode-block" id="pause"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.pause.html#matplotlib.pyplot.pause">[docs]</a>def pause(interval):

"""

Run the GUI event loop for *interval* seconds.

If there is an active figure, it will be updated and displayed before the

pause, and the GUI event loop (if any) will run during the pause.

This can be used for crude animation. For more complex animation use

:mod:`matplotlib.animation`.

If there is no active figure, sleep for *interval* seconds instead.

See Also

--------

matplotlib.animation : Complex animation

show : show figures and optional block forever

"""

manager = _pylab_helpers.Gcf.get_active()

if manager is not None:

canvas = manager.canvas

if canvas.figure.stale:

canvas.draw_idle()

show(block=False)

canvas.start_event_loop(interval)

else:

time.sleep(interval)</div>

<div class="viewcode-block" id="rc"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.rc.html#matplotlib.pyplot.rc">[docs]</a>@_copy_docstring_and_deprecators(matplotlib.rc)

def rc(group, **kwargs):

matplotlib.rc(group, **kwargs)</div>

@_copy_docstring_and_deprecators(matplotlib.rc_context)

def rc_context(rc=None, fname=None):

return matplotlib.rc_context(rc, fname)

@_copy_docstring_and_deprecators(matplotlib.rcdefaults)

def rcdefaults():

matplotlib.rcdefaults()

if matplotlib.is_interactive():

draw_all()

# getp/get/setp are explicitly reexported so that they show up in pyplot docs.

<div class="viewcode-block" id="getp"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.getp.html#matplotlib.pyplot.getp">[docs]</a>@_copy_docstring_and_deprecators(matplotlib.artist.getp)

def getp(obj, *args, **kwargs):

return matplotlib.artist.getp(obj, *args, **kwargs)</div>

<div class="viewcode-block" id="get"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.get.html#matplotlib.pyplot.get">[docs]</a>@_copy_docstring_and_deprecators(matplotlib.artist.get)

def get(obj, *args, **kwargs):

return matplotlib.artist.get(obj, *args, **kwargs)</div>

@_copy_docstring_and_deprecators(matplotlib.artist.setp)

def setp(obj, *args, **kwargs):

return matplotlib.artist.setp(obj, *args, **kwargs)

def xkcd(scale=1, length=100, randomness=2):

"""

Turn on `xkcd <https://xkcd.com/>`_ sketch-style drawing mode. This will

only have effect on things drawn after this function is called.

For best results, the "Humor Sans" font should be installed: it is

not included with Matplotlib.

Parameters

----------

scale : float, optional

The amplitude of the wiggle perpendicular to the source line.

length : float, optional

The length of the wiggle along the line.

randomness : float, optional

The scale factor by which the length is shrunken or expanded.

Notes

-----

This function works by a number of rcParams, so it will probably

override others you have set before.

If you want the effects of this function to be temporary, it can

be used as a context manager, for example::

with plt.xkcd():

# This figure will be in XKCD-style

fig1 = plt.figure()

# ...

# This figure will be in regular style

fig2 = plt.figure()

"""

return _xkcd(scale, length, randomness)

class _xkcd:

# This cannot be implemented in terms of rc_context() because this needs to

# work as a non-contextmanager too.

def __init__(self, scale, length, randomness):

self._orig = rcParams.copy()

if rcParams['text.usetex']:

raise RuntimeError(

"xkcd mode is not compatible with text.usetex = True")

from matplotlib import patheffects

rcParams.update({

'font.family': ['xkcd', 'xkcd Script', 'Humor Sans', 'Comic Neue',

'Comic Sans MS'],

'font.size': 14.0,

'path.sketch': (scale, length, randomness),

'path.effects': [

patheffects.withStroke(linewidth=4, foreground="w")],

'axes.linewidth': 1.5,

'lines.linewidth': 2.0,

'figure.facecolor': 'white',

'grid.linewidth': 0.0,

'axes.grid': False,

'axes.unicode_minus': False,

'axes.edgecolor': 'black',

'xtick.major.size': 8,

'xtick.major.width': 3,

'ytick.major.size': 8,

'ytick.major.width': 3,

})

def __enter__(self):

return self

def __exit__(self, *args):

dict.update(rcParams, self._orig)

## Figures ##

<div class="viewcode-block" id="figure"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure">[docs]</a>def figure(num=None, # autoincrement if None, else integer from 1-N

figsize=None, # defaults to rc figure.figsize

dpi=None, # defaults to rc figure.dpi

facecolor=None, # defaults to rc figure.facecolor

edgecolor=None, # defaults to rc figure.edgecolor

frameon=True,

FigureClass=Figure,

clear=False,

**kwargs

):

"""

Create a new figure, or activate an existing figure.

Parameters

----------

num : int or str, optional

A unique identifier for the figure.

If a figure with that identifier already exists, this figure is made

active and returned. An integer refers to the ``Figure.number``

attribute, a string refers to the figure label.

If there is no figure with the identifier or *num* is not given, a new

figure is created, made active and returned. If *num* is an int, it

will be used for the ``Figure.number`` attribute, otherwise, an

auto-generated integer value is used (starting at 1 and incremented

for each new figure). If *num* is a string, the figure label and the

window title is set to this value.

figsize : (float, float), default: :rc:`figure.figsize`

Width, height in inches.

dpi : float, default: :rc:`figure.dpi`

The resolution of the figure in dots-per-inch.

facecolor : color, default: :rc:`figure.facecolor`

The background color.

edgecolor : color, default: :rc:`figure.edgecolor`

The border color.

frameon : bool, default: True

If False, suppress drawing the figure frame.

FigureClass : subclass of `~matplotlib.figure.Figure`

Optionally use a custom `.Figure` instance.

clear : bool, default: False

If True and the figure already exists, then it is cleared.

tight_layout : bool or dict, default: :rc:`figure.autolayout`

If ``False`` use *subplotpars*. If ``True`` adjust subplot

parameters using `.tight_layout` with default padding.

When providing a dict containing the keys ``pad``, ``w_pad``,

``h_pad``, and ``rect``, the default `.tight_layout` paddings

will be overridden.

constrained_layout : bool, default: :rc:`figure.constrained_layout.use`

If ``True`` use constrained layout to adjust positioning of plot

elements. Like ``tight_layout``, but designed to be more

flexible. See

:doc:`/tutorials/intermediate/constrainedlayout_guide`

for examples. (Note: does not work with `add_subplot` or

`~.pyplot.subplot2grid`.)

**kwargs : optional

See `~.matplotlib.figure.Figure` for other possible arguments.

Returns

-------

`~matplotlib.figure.Figure`

The `.Figure` instance returned will also be passed to

new_figure_manager in the backends, which allows to hook custom

`.Figure` classes into the pyplot interface. Additional kwargs will be

passed to the `.Figure` init function.

Notes

-----

If you are creating many figures, make sure you explicitly call

`.pyplot.close` on the figures you are not using, because this will

enable pyplot to properly clean up the memory.

`~matplotlib.rcParams` defines the default values, which can be modified

in the matplotlibrc file.

"""

if figsize is None:

figsize = rcParams['figure.figsize']

if dpi is None:

dpi = rcParams['figure.dpi']

if facecolor is None:

facecolor = rcParams['figure.facecolor']

if edgecolor is None:

edgecolor = rcParams['figure.edgecolor']

allnums = get_fignums()

next_num = max(allnums) + 1 if allnums else 1

figLabel = ''

if num is None:

num = next_num

elif isinstance(num, str):

figLabel = num

allLabels = get_figlabels()

if figLabel not in allLabels:

if figLabel == 'all':

cbook._warn_external(

"close('all') closes all existing figures")

num = next_num

else:

inum = allLabels.index(figLabel)

num = allnums[inum]

else:

num = int(num) # crude validation of num argument

figManager = _pylab_helpers.Gcf.get_fig_manager(num)

if figManager is None:

max_open_warning = rcParams['figure.max_open_warning']

if len(allnums) == max_open_warning >= 1:

cbook._warn_external(

"More than %d figures have been opened. Figures "

"created through the pyplot interface "

"(`matplotlib.pyplot.figure`) are retained until "

"explicitly closed and may consume too much memory. "

"(To control this warning, see the rcParam "

"`figure.max_open_warning`)." %

max_open_warning, RuntimeWarning)

if get_backend().lower() == 'ps':

dpi = 72

figManager = new_figure_manager(num, figsize=figsize,

dpi=dpi,

facecolor=facecolor,

edgecolor=edgecolor,

frameon=frameon,

FigureClass=FigureClass,

**kwargs)

fig = figManager.canvas.figure

if figLabel:

fig.set_label(figLabel)

_pylab_helpers.Gcf._set_new_active_manager(figManager)

# make sure backends (inline) that we don't ship that expect this

# to be called in plotting commands to make the figure call show

# still work. There is probably a better way to do this in the

# FigureManager base class.

draw_if_interactive()

if _INSTALL_FIG_OBSERVER:

fig.stale_callback = _auto_draw_if_interactive

if clear:

figManager.canvas.figure.clear()

return figManager.canvas.figure</div>

def _auto_draw_if_interactive(fig, val):

"""

An internal helper function for making sure that auto-redrawing

works as intended in the plain python repl.

Parameters

----------

fig : Figure

A figure object which is assumed to be associated with a canvas

"""

if (val and matplotlib.is_interactive()

and not fig.canvas.is_saving()

# Some artists can mark themselves as stale in the middle of drawing

# (e.g. axes position & tick labels being computed at draw time), but

# this shouldn't trigger a redraw because the current redraw will

# already take them into account.

with fig.canvas._idle_draw_cntx():

fig.canvas.draw_idle()

<div class="viewcode-block" id="gcf"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.gcf.html#matplotlib.pyplot.gcf">[docs]</a>def gcf():

"""

Get the current figure.

If no current figure exists, a new one is created using

`~.pyplot.figure()`.

"""

if figManager is not None:

return figManager.canvas.figure

else:

return figure()</div>

<div class="viewcode-block" id="fignum_exists"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.fignum_exists.html#matplotlib.pyplot.fignum_exists">[docs]</a>def fignum_exists(num):

"""Return whether the figure with the given id exists."""

return _pylab_helpers.Gcf.has_fignum(num) or num in get_figlabels()</div>

<div class="viewcode-block" id="get_fignums"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.get_fignums.html#matplotlib.pyplot.get_fignums">[docs]</a>def get_fignums():

"""Return a list of existing figure numbers."""

return sorted(_pylab_helpers.Gcf.figs)</div>

<div class="viewcode-block" id="get_figlabels"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.get_figlabels.html#matplotlib.pyplot.get_figlabels">[docs]</a>def get_figlabels():

"""Return a list of existing figure labels."""

figManagers = _pylab_helpers.Gcf.get_all_fig_managers()

figManagers.sort(key=lambda m: m.num)

return [m.canvas.figure.get_label() for m in figManagers]</div>

<div class="viewcode-block" id="get_current_fig_manager"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.get_current_fig_manager.html#matplotlib.pyplot.get_current_fig_manager">[docs]</a>def get_current_fig_manager():

"""

Return the figure manager of the current figure.

The figure manager is a container for the actual backend-depended window

that displays the figure on screen.

If if no current figure exists, a new one is created an its figure

manager is returned.

Returns

-------

`.FigureManagerBase` or backend-dependent subclass thereof

"""

return gcf().canvas.manager</div>

@_copy_docstring_and_deprecators(FigureCanvasBase.mpl_connect)

def connect(s, func):

return gcf().canvas.mpl_connect(s, func)

def disconnect(cid):

return gcf().canvas.mpl_disconnect(cid)

def close(fig=None):

"""

Close a figure window.

Parameters

----------

fig : None or int or str or `.Figure`

The figure to close. There are a number of ways to specify this:

- *None*: the current figure

- `.Figure`: the given `.Figure` instance

- ``int``: a figure number

- ``str``: a figure name

- 'all': all figures

"""

if fig is None:

if figManager is None:

return

else:

_pylab_helpers.Gcf.destroy(figManager)

elif fig == 'all':

_pylab_helpers.Gcf.destroy_all()

elif isinstance(fig, int):

elif hasattr(fig, 'int'):

# if we are dealing with a type UUID, we

# can use its integer representation

elif isinstance(fig, str):

allLabels = get_figlabels()

if fig in allLabels:

num = get_fignums()[allLabels.index(fig)]

elif isinstance(fig, Figure):

_pylab_helpers.Gcf.destroy_fig(fig)

else:

raise TypeError("close() argument must be a Figure, an int, a string, "

"or None, not '%s'")

def clf():

"""Clear the current figure."""

gcf().clf()

def draw():

"""

Redraw the current figure.

This is used to update a figure that has been altered, but not

automatically re-drawn. If interactive mode is on (via `.ion()`), this

should be only rarely needed, but there may be ways to modify the state of

a figure without marking it as "stale". Please report these cases as bugs.

This is equivalent to calling ``fig.canvas.draw_idle()``, where ``fig`` is

the current figure.

"""

gcf().canvas.draw_idle()

@_copy_docstring_and_deprecators(Figure.savefig)

def savefig(*args, **kwargs):

fig = gcf()

res = fig.savefig(*args, **kwargs)

fig.canvas.draw_idle() # need this if 'transparent=True' to reset colors

return res

## Putting things in figures ##

<div class="viewcode-block" id="figlegend"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.pyplot.figlegend.html#matplotlib.pyplot.figlegend">[docs]</a>def figlegend(*args, **kwargs):

return gcf().legend(*args, **kwargs)</div>

if Figure.legend.__doc__:

figlegend.__doc__ = Figure.legend.__doc__.replace("legend(", "figlegend(")

## Axes ##

@docstring.dedent_interpd

def axes(arg=None, **kwargs):

"""

Add an axes to the current figure and make it the current axes.

Call signatures::

plt.axes()

plt.axes(rect, projection=None, polar=False, **kwargs)

plt.axes(ax)

Parameters

----------

arg : None or 4-tuple

The exact behavior of this function depends on the type:

- *None*: A new full window axes is added using

``subplot(111, **kwargs)``.

- 4-tuple of floats *rect* = ``[left, bottom, width, height]``.

A new axes is added with dimensions *rect* in normalized

(0, 1) units using `~.Figure.add_axes` on the current figure.

projection : {None, 'aitoff', 'hammer', 'lambert', 'mollweide', \

'polar', 'rectilinear', str}, optional

The projection type of the `~.axes.Axes`. *str* is the name of

a custom projection, see `~matplotlib.projections`. The default

None results in a 'rectilinear' projection.

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

pyplot.html

Latest commit

History

pyplot.html

File metadata and controls