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

History

3022 lines (2489 loc) · 319 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.figure — 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.figure</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.figure</h1><div class="highlight"><pre>

"""

`matplotlib.figure` implements the following classes:

`Figure`

Top level `~matplotlib.artist.Artist`, which holds all plot elements.

`SubplotParams`

Control the default spacing between subplots.

"""

import inspect

import logging

from numbers import Integral

import numpy as np

import matplotlib as mpl

from matplotlib import docstring, projections

from matplotlib import __version__ as _mpl_version

import matplotlib.artist as martist

from matplotlib.artist import Artist, allow_rasterization

from matplotlib.backend_bases import (

FigureCanvasBase, NonGuiException, MouseButton)

import matplotlib.cbook as cbook

import matplotlib.colorbar as cbar

import matplotlib.image as mimage

from matplotlib.axes import Axes, SubplotBase, subplot_class_factory

from matplotlib.blocking_input import BlockingMouseInput, BlockingKeyMouseInput

from matplotlib.gridspec import GridSpec, SubplotSpec # noqa: F401

import matplotlib.legend as mlegend

from matplotlib.patches import Rectangle

from matplotlib.text import Text

from matplotlib.transforms import (Affine2D, Bbox, BboxTransformTo,

TransformedBbox)

import matplotlib._layoutbox as layoutbox

_log = logging.getLogger(__name__)

def _stale_figure_callback(self, val):

if self.figure:

self.figure.stale = val

class _AxesStack(cbook.Stack):

"""

Specialization of `.Stack`, to handle all tracking of `~.axes.Axes` in a

`.Figure`.

This stack stores ``key, (ind, axes)`` pairs, where:

* **key** is a hash of the args and kwargs used in generating the Axes.

* **ind** is a serial index tracking the order in which axes were added.

AxesStack is a callable; calling it returns the current axes.

The `current_key_axes` method returns the current key and associated axes.

"""

def __init__(self):

super().__init__()

self._ind = 0

def as_list(self):

"""

Return a list of the Axes instances that have been added to the figure.

"""

ia_list = [a for k, a in self._elements]

ia_list.sort()

return [a for i, a in ia_list]

def get(self, key):

"""

Return the Axes instance that was added with *key*.

If it is not present, return *None*.

"""

item = dict(self._elements).get(key)

if item is None:

return None

cbook.warn_deprecated(

"2.1",

message="Adding an axes using the same arguments as a previous "

"axes currently reuses the earlier instance. In a future "

"version, a new instance will always be created and returned. "

"Meanwhile, this warning can be suppressed, and the future "

"behavior ensured, by passing a unique label to each axes "

"instance.")

return item[1]

def _entry_from_axes(self, e):

ind, k = {a: (ind, k) for k, (ind, a) in self._elements}[e]

return (k, (ind, e))

def remove(self, a):

"""Remove the axes from the stack."""

super().remove(self._entry_from_axes(a))

def bubble(self, a):

"""

Move the given axes, which must already exist in the

stack, to the top.

"""

return super().bubble(self._entry_from_axes(a))

def add(self, key, a):

"""

Add Axes *a*, with key *key*, to the stack, and return the stack.

If *key* is unhashable, replace it by a unique, arbitrary object.

If *a* is already on the stack, don't add it again, but

return *None*.

"""

# All the error checking may be unnecessary; but this method

# is called so seldom that the overhead is negligible.

cbook._check_isinstance(Axes, a=a)

try:

hash(key)

except TypeError:

key = object()

a_existing = self.get(key)

if a_existing is not None:

super().remove((key, a_existing))

cbook._warn_external(

"key {!r} already existed; Axes is being replaced".format(key))

# I don't think the above should ever happen.

if a in self:

return None

self._ind += 1

return super().push((key, (self._ind, a)))

def current_key_axes(self):

"""

Return a tuple of ``(key, axes)`` for the active axes.

If no axes exists on the stack, then returns ``(None, None)``.

"""

if not len(self._elements):

return self._default, self._default

else:

key, (index, axes) = self._elements[self._pos]

return key, axes

def __call__(self):

return self.current_key_axes()[1]

def __contains__(self, a):

return a in self.as_list()

<div class="viewcode-block" id="AxesStack"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.AxesStack.html#matplotlib.figure.AxesStack">[docs]</a>@cbook.deprecated("3.2")

class AxesStack(_AxesStack):

pass</div>

<div class="viewcode-block" id="SubplotParams"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.SubplotParams.html#matplotlib.figure.SubplotParams">[docs]</a>class SubplotParams:

"""

A class to hold the parameters for a subplot.

"""

<div class="viewcode-block" id="SubplotParams.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.SubplotParams.html#matplotlib.figure.SubplotParams.__init__">[docs]</a> def __init__(self, left=None, bottom=None, right=None, top=None,

wspace=None, hspace=None):

"""

Defaults are given by :rc:`figure.subplot.[name]`.

Parameters

----------

left : float

The position of the left edge of the subplots,

as a fraction of the figure width.

right : float

The position of the right edge of the subplots,

as a fraction of the figure width.

bottom : float

The position of the bottom edge of the subplots,

as a fraction of the figure height.

top : float

The position of the top edge of the subplots,

as a fraction of the figure height.

wspace : float

The width of the padding between subplots,

as a fraction of the average axes width.

hspace : float

The height of the padding between subplots,

as a fraction of the average axes height.

"""

self.validate = True

for key in ["left", "bottom", "right", "top", "wspace", "hspace"]:

setattr(self, key, mpl.rcParams[f"figure.subplot.{key}"])

self.update(left, bottom, right, top, wspace, hspace)</div>

<div class="viewcode-block" id="SubplotParams.update"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.SubplotParams.html#matplotlib.figure.SubplotParams.update">[docs]</a> def update(self, left=None, bottom=None, right=None, top=None,

"""

Update the dimensions of the passed parameters. *None* means unchanged.

"""

if self.validate:

if ((left if left is not None else self.left)

>= (right if right is not None else self.right)):

raise ValueError('left cannot be >= right')

if ((bottom if bottom is not None else self.bottom)

>= (top if top is not None else self.top)):

raise ValueError('bottom cannot be >= top')

if left is not None:

self.left = left

if right is not None:

self.right = right

if bottom is not None:

self.bottom = bottom

if top is not None:

self.top = top

if wspace is not None:

self.wspace = wspace

if hspace is not None:

self.hspace = hspace</div></div>

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

"""

The top level container for all the plot elements.

The Figure instance supports callbacks through a *callbacks* attribute

which is a `.CallbackRegistry` instance. The events you can connect to

are 'dpi_changed', and the callback will be called with ``func(fig)`` where

fig is the `Figure` instance.

Attributes

----------

patch

The `.Rectangle` instance representing the figure background patch.

suppressComposite

For multiple figure images, the figure will make composite images

depending on the renderer option_image_nocomposite function. If

*suppressComposite* is a boolean, this will override the renderer.

"""

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

return "Figure(%gx%g)" % tuple(self.bbox.size)</div>

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

return "<{clsname} size {h:g}x{w:g} with {naxes} Axes>".format(

clsname=self.__class__.__name__,

h=self.bbox.size[0], w=self.bbox.size[1],

naxes=len(self.axes),

)</div>

<div class="viewcode-block" id="Figure.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.__init__">[docs]</a> def __init__(self,

figsize=None,

dpi=None,

facecolor=None,

edgecolor=None,

linewidth=0.0,

frameon=None,

subplotpars=None, # rc figure.subplot.*

tight_layout=None, # rc figure.autolayout

constrained_layout=None, # rc figure.constrained_layout.use

):

"""

Parameters

----------

figsize : 2-tuple of floats, default: :rc:`figure.figsize`

Figure dimension ``(width, height)`` in inches.

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

Dots per inch.

facecolor : default: :rc:`figure.facecolor`

The figure patch facecolor.

edgecolor : default: :rc:`figure.edgecolor`

The figure patch edge color.

linewidth : float

The linewidth of the frame (i.e. the edge linewidth of the figure

patch).

frameon : bool, default: :rc:`figure.frameon`

If ``False``, suppress drawing the figure background patch.

subplotpars : `SubplotParams`

Subplot parameters. If not given, the default subplot

parameters :rc:`figure.subplot.*` are used.

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`.)

"""

super().__init__()

# remove the non-figure artist _axes property

# as it makes no sense for a figure to be _in_ an axes

# this is used by the property methods in the artist base class

# which are over-ridden in this class

del self._axes

self.callbacks = cbook.CallbackRegistry()

if figsize is None:

figsize = mpl.rcParams['figure.figsize']

if dpi is None:

dpi = mpl.rcParams['figure.dpi']

if facecolor is None:

facecolor = mpl.rcParams['figure.facecolor']

if edgecolor is None:

edgecolor = mpl.rcParams['figure.edgecolor']

if frameon is None:

frameon = mpl.rcParams['figure.frameon']

if not np.isfinite(figsize).all() or (np.array(figsize) < 0).any():

raise ValueError('figure size must be positive finite not '

f'{figsize}')

self.bbox_inches = Bbox.from_bounds(0, 0, *figsize)

self.dpi_scale_trans = Affine2D().scale(dpi)

# do not use property as it will trigger

self._dpi = dpi

self.bbox = TransformedBbox(self.bbox_inches, self.dpi_scale_trans)

self.transFigure = BboxTransformTo(self.bbox)

self.patch = Rectangle(

xy=(0, 0), width=1, height=1, visible=frameon,

facecolor=facecolor, edgecolor=edgecolor, linewidth=linewidth,

# Don't let the figure patch influence bbox calculation.

in_layout=False)

self._set_artist_props(self.patch)

self.patch.set_antialiased(False)

FigureCanvasBase(self) # Set self.canvas.

self._suptitle = None

if subplotpars is None:

subplotpars = SubplotParams()

self.subplotpars = subplotpars

# constrained_layout:

self._layoutbox = None

# set in set_constrained_layout_pads()

self.set_constrained_layout(constrained_layout)

self.set_tight_layout(tight_layout)

self._axstack = _AxesStack() # track all figure axes and current axes

self.clf()

self._cachedRenderer = None

# groupers to keep track of x and y labels we want to align.

# see self.align_xlabels and self.align_ylabels and

# axis._get_tick_boxes_siblings

self._align_xlabel_grp = cbook.Grouper()

self._align_ylabel_grp = cbook.Grouper()

# list of child gridspecs for this figure

self._gridspecs = []</div>

# TODO: I'd like to dynamically add the _repr_html_ method

# to the figure in the right context, but then IPython doesn't

# use it, for some reason.

def _repr_html_(self):

# We can't use "isinstance" here, because then we'd end up importing

# webagg unconditionally.

if 'WebAgg' in type(self.canvas).__name__:

from matplotlib.backends import backend_webagg

return backend_webagg.ipython_inline_display(self)

<div class="viewcode-block" id="Figure.show"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.show">[docs]</a> def show(self, warn=True):

"""

If using a GUI backend with pyplot, display the figure window.

If the figure was not created using `~.pyplot.figure`, it will lack

a `~.backend_bases.FigureManagerBase`, and this method will raise an

AttributeError.

.. warning::

This does not manage an GUI event loop. Consequently, the figure

may only be shown briefly or not shown at all if you or your

environment are not managing an event loop.

Proper use cases for `.Figure.show` include running this from a

GUI application or an IPython shell.

If you're running a pure python shell or executing a non-GUI

python script, you should use `matplotlib.pyplot.show` instead,

which takes care of managing the event loop for you.

Parameters

----------

warn : bool, default: True

If ``True`` and we are not running headless (i.e. on Linux with an

unset DISPLAY), issue warning when called on a non-GUI backend.

"""

if self.canvas.manager is None:

raise AttributeError(

"Figure.show works only for figures managed by pyplot, "

"normally created by pyplot.figure()")

try:

self.canvas.manager.show()

except NonGuiException as exc:

cbook._warn_external(str(exc))</div>

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

"""

Return a list of axes in the Figure. You can access and modify the

axes in the Figure through this list.

Do not modify the list itself. Instead, use `~Figure.add_axes`,

`~.Figure.add_subplot` or `~.Figure.delaxes` to add or remove an axes.

Note: This is equivalent to the property `~.Figure.axes`.

"""

return self._axstack.as_list()</div>

axes = property(get_axes, doc="""

List of axes in the Figure. You can access and modify the axes in the

Figure through this list.

Do not modify the list itself. Instead, use "`~Figure.add_axes`,

`~.Figure.add_subplot` or `~.Figure.delaxes` to add or remove an axes.

""")

def _get_dpi(self):

return self._dpi

def _set_dpi(self, dpi, forward=True):

"""

Parameters

----------

dpi : float

forward : bool

Passed on to `~.Figure.set_size_inches`

"""

if dpi == self._dpi:

# We don't want to cause undue events in backends.

return

self._dpi = dpi

self.dpi_scale_trans.clear().scale(dpi)

w, h = self.get_size_inches()

self.set_size_inches(w, h, forward=forward)

self.callbacks.process('dpi_changed', self)

dpi = property(_get_dpi, _set_dpi, doc="The resolution in dots per inch.")

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

"""Return whether `.tight_layout` is called when drawing."""

return self._tight</div>

<div class="viewcode-block" id="Figure.set_tight_layout"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.set_tight_layout">[docs]</a> def set_tight_layout(self, tight):

"""

Set whether and how `.tight_layout` is called when drawing.

Parameters

----------

tight : bool or dict with keys "pad", "w_pad", "h_pad", "rect" or None

If a bool, sets whether to call `.tight_layout` upon drawing.

If ``None``, use the ``figure.autolayout`` rcparam instead.

If a dict, pass it as kwargs to `.tight_layout`, overriding the

default paddings.

"""

if tight is None:

tight = mpl.rcParams['figure.autolayout']

self._tight = bool(tight)

self._tight_parameters = tight if isinstance(tight, dict) else {}

self.stale = True</div>

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

"""

Return whether constrained layout is being used.

See :doc:`/tutorials/intermediate/constrainedlayout_guide`.

"""

return self._constrained</div>

<div class="viewcode-block" id="Figure.set_constrained_layout"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.set_constrained_layout">[docs]</a> def set_constrained_layout(self, constrained):

"""

Set whether ``constrained_layout`` is used upon drawing. If None,

:rc:`figure.constrained_layout.use` value will be used.

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

the default ``constrained_layout`` paddings will be

overridden. These pads are in inches and default to 3.0/72.0.

``w_pad`` is the width padding and ``h_pad`` is the height padding.

See :doc:`/tutorials/intermediate/constrainedlayout_guide`.

Parameters

----------

constrained : bool or dict or None

"""

self._constrained_layout_pads = dict()

self._constrained_layout_pads['w_pad'] = None

self._constrained_layout_pads['h_pad'] = None

self._constrained_layout_pads['wspace'] = None

self._constrained_layout_pads['hspace'] = None

if constrained is None:

constrained = mpl.rcParams['figure.constrained_layout.use']

self._constrained = bool(constrained)

if isinstance(constrained, dict):

self.set_constrained_layout_pads(**constrained)

else:

self.set_constrained_layout_pads()

self.stale = True</div>

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

"""

Set padding for ``constrained_layout``. Note the kwargs can be passed

as a dictionary ``fig.set_constrained_layout(**paddict)``.

See :doc:`/tutorials/intermediate/constrainedlayout_guide`.

Parameters

----------

w_pad : float

Width padding in inches. This is the pad around axes

and is meant to make sure there is enough room for fonts to

look good. Defaults to 3 pts = 0.04167 inches

h_pad : float

Height padding in inches. Defaults to 3 pts.

wspace : float

Width padding between subplots, expressed as a fraction of the

subplot width. The total padding ends up being w_pad + wspace.

hspace : float

Height padding between subplots, expressed as a fraction of the

subplot width. The total padding ends up being h_pad + hspace.

"""

todo = ['w_pad', 'h_pad', 'wspace', 'hspace']

for td in todo:

if td in kwargs and kwargs[td] is not None:

self._constrained_layout_pads[td] = kwargs[td]

else:

mpl.rcParams['figure.constrained_layout.' + td])</div>

<div class="viewcode-block" id="Figure.get_constrained_layout_pads"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.get_constrained_layout_pads">[docs]</a> def get_constrained_layout_pads(self, relative=False):

"""

Get padding for ``constrained_layout``.

Returns a list of ``w_pad, h_pad`` in inches and

``wspace`` and ``hspace`` as fractions of the subplot.

See :doc:`/tutorials/intermediate/constrainedlayout_guide`.

Parameters

----------

relative : bool

If `True`, then convert from inches to figure relative.

"""

w_pad = self._constrained_layout_pads['w_pad']

h_pad = self._constrained_layout_pads['h_pad']

wspace = self._constrained_layout_pads['wspace']

hspace = self._constrained_layout_pads['hspace']

if relative and (w_pad is not None or h_pad is not None):

renderer0 = layoutbox.get_renderer(self)

dpi = renderer0.dpi

w_pad = w_pad * dpi / renderer0.width

h_pad = h_pad * dpi / renderer0.height

return w_pad, h_pad, wspace, hspace</div>

<div class="viewcode-block" id="Figure.autofmt_xdate"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.autofmt_xdate">[docs]</a> def autofmt_xdate(

self, bottom=0.2, rotation=30, ha='right', which='major'):

"""

Date ticklabels often overlap, so it is useful to rotate them

and right align them. Also, a common use case is a number of

subplots with shared xaxes where the x-axis is date data. The

ticklabels are often long, and it helps to rotate them on the

bottom subplot and turn them off on other subplots, as well as

turn off xlabels.

Parameters

----------

bottom : float, default: 0.2

The bottom of the subplots for `subplots_adjust`.

rotation : float, default: 30 degrees

The rotation angle of the xtick labels in degrees.

ha : {'left', 'center', 'right'}, default: 'right'

The horizontal alignment of the xticklabels.

which : {'major', 'minor', 'both'}, default: 'major'

Selects which ticklabels to rotate.

"""

if which is None:

cbook.warn_deprecated(

"3.3", message="Support for passing which=None to mean "

"which='major' is deprecated since %(since)s and will be "

"removed %(removal)s.")

allsubplots = all(hasattr(ax, 'is_last_row') for ax in self.axes)

if len(self.axes) == 1:

for label in self.axes[0].get_xticklabels(which=which):

label.set_ha(ha)

label.set_rotation(rotation)

else:

if allsubplots:

for ax in self.get_axes():

if ax.is_last_row():

for label in ax.get_xticklabels(which=which):

label.set_ha(ha)

label.set_rotation(rotation)

else:

label.set_visible(False)

ax.set_xlabel('')

if allsubplots:

self.subplots_adjust(bottom=bottom)

self.stale = True</div>

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

"""Get a list of artists contained in the figure."""

return [self.patch,

*self.artists,

*self.axes,

*self.lines,

*self.patches,

*self.texts,

*self.images,

*self.legends]</div>

<div class="viewcode-block" id="Figure.contains"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.contains">[docs]</a> def contains(self, mouseevent):

"""

Test whether the mouse event occurred on the figure.

Returns

-------

bool, {}

"""

inside, info = self._default_contains(mouseevent, figure=self)

if inside is not None:

return inside, info

inside = self.bbox.contains(mouseevent.x, mouseevent.y)

return inside, {}</div>

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

"""

Return the figure bounding box in display space. Arguments are ignored.

"""

return self.bbox</div>

<div class="viewcode-block" id="Figure.suptitle"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.suptitle">[docs]</a> def suptitle(self, t, **kwargs):

"""

Add a centered title to the figure.

Parameters

----------

t : str

The title text.

x : float, default 0.5

The x location of the text in figure coordinates.

y : float, default 0.98

The y location of the text in figure coordinates.

horizontalalignment, ha : {'center', 'left', right'}, default: 'center'

The horizontal alignment of the text relative to (*x*, *y*).

verticalalignment, va : {'top', 'center', 'bottom', 'baseline'}, \

default: 'top'

The vertical alignment of the text relative to (*x*, *y*).

fontsize, size : default: :rc:`figure.titlesize`

The font size of the text. See `.Text.set_size` for possible

values.

fontweight, weight : default: :rc:`figure.titleweight`

The font weight of the text. See `.Text.set_weight` for possible

values.

Returns

-------

text

The `.Text` instance of the title.

Other Parameters

----------------

fontproperties : None or dict, optional

A dict of font properties. If *fontproperties* is given the

default values for font size and weight are taken from the

`.FontProperties` defaults. :rc:`figure.titlesize` and

:rc:`figure.titleweight` are ignored in this case.

**kwargs

Additional kwargs are `matplotlib.text.Text` properties.

Examples

--------

>>> fig.suptitle('This is the figure title', fontsize=12)

"""

manual_position = ('x' in kwargs or 'y' in kwargs)

x = kwargs.pop('x', 0.5)

y = kwargs.pop('y', 0.98)

if 'horizontalalignment' not in kwargs and 'ha' not in kwargs:

kwargs['horizontalalignment'] = 'center'

if 'verticalalignment' not in kwargs and 'va' not in kwargs:

kwargs['verticalalignment'] = 'top'

if 'fontproperties' not in kwargs:

if 'fontsize' not in kwargs and 'size' not in kwargs:

kwargs['size'] = mpl.rcParams['figure.titlesize']

if 'fontweight' not in kwargs and 'weight' not in kwargs:

kwargs['weight'] = mpl.rcParams['figure.titleweight']

sup = self.text(x, y, t, **kwargs)

if self._suptitle is not None:

self._suptitle.set_text(t)

self._suptitle.set_position((x, y))

self._suptitle.update_from(sup)

sup.remove()

else:

self._suptitle = sup

self._suptitle._layoutbox = None

if self._layoutbox is not None and not manual_position:

w_pad, h_pad, wspace, hspace = \

self.get_constrained_layout_pads(relative=True)

figlb = self._layoutbox

self._suptitle._layoutbox = layoutbox.LayoutBox(

parent=figlb, artist=self._suptitle,

name=figlb.name+'.suptitle')

# stack the suptitle on top of all the children.

# Some day this should be on top of all the children in the

# gridspec only.

for child in figlb.children:

if child is not self._suptitle._layoutbox:

layoutbox.vstack([self._suptitle._layoutbox,

child],

padding=h_pad*2., strength='required')

self.stale = True

return self._suptitle</div>

<div class="viewcode-block" id="Figure.set_canvas"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.set_canvas">[docs]</a> def set_canvas(self, canvas):

"""

Set the canvas that contains the figure

Parameters

----------

canvas : FigureCanvas

"""

self.canvas = canvas</div>

<div class="viewcode-block" id="Figure.figimage"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.figimage">[docs]</a> def figimage(self, X, xo=0, yo=0, alpha=None, norm=None, cmap=None,

vmin=None, vmax=None, origin=None, resize=False, **kwargs):

"""

Add a non-resampled image to the figure.

The image is attached to the lower or upper left corner depending on

*origin*.

Parameters

----------

X

The image data. This is an array of one of the following shapes:

- MxN: luminance (grayscale) values

- MxNx3: RGB values

- MxNx4: RGBA values

xo, yo : int

The *x*/*y* image offset in pixels.

alpha : None or float

The alpha blending value.

norm : `matplotlib.colors.Normalize`

A `.Normalize` instance to map the luminance to the

interval [0, 1].

cmap : str or `matplotlib.colors.Colormap`, default: :rc:`image.cmap`

The colormap to use.

vmin, vmax : float

If *norm* is not given, these values set the data limits for the

colormap.

origin : {'upper', 'lower'}, default: :rc:`image.origin`

Indicates where the [0, 0] index of the array is in the upper left

or lower left corner of the axes.

resize : bool

If *True*, resize the figure to match the given image size.

Returns

-------

`matplotlib.image.FigureImage`

Other Parameters

----------------

**kwargs

Additional kwargs are `.Artist` kwargs passed on to `.FigureImage`.

Notes

-----

figimage complements the axes image (`~matplotlib.axes.Axes.imshow`)

which will be resampled to fit the current axes. If you want

a resampled image to fill the entire figure, you can define an

`~matplotlib.axes.Axes` with extent [0, 0, 1, 1].

Examples

--------

::

f = plt.figure()

nx = int(f.get_figwidth() * f.dpi)

ny = int(f.get_figheight() * f.dpi)

data = np.random.random((ny, nx))

f.figimage(data)

plt.show()

"""

if resize:

dpi = self.get_dpi()

figsize = [x / dpi for x in (X.shape[1], X.shape[0])]

self.set_size_inches(figsize, forward=True)

im = mimage.FigureImage(self, cmap, norm, xo, yo, origin, **kwargs)

im.stale_callback = _stale_figure_callback

im.set_array(X)

im.set_alpha(alpha)

if norm is None:

im.set_clim(vmin, vmax)

self.images.append(im)

im._remove_method = self.images.remove

self.stale = True

return im</div>

<div class="viewcode-block" id="Figure.set_size_inches"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure.set_size_inches">[docs]</a> def set_size_inches(self, w, h=None, forward=True):

"""

Set the figure size in inches.

Call signatures::

fig.set_size_inches(w, h) # OR

fig.set_size_inches((w, h))

Parameters

----------

w : (float, float) or float

Width and height in inches (if height not specified as a separate

argument) or width.

h : float

Height in inches.

forward : bool, default: True

If ``True``, the canvas size is automatically updated, e.g.,

you can resize the figure window from the shell.

See Also

--------

matplotlib.figure.Figure.get_size_inches

matplotlib.figure.Figure.set_figwidth

matplotlib.figure.Figure.set_figheight

Notes

-----

To transform from pixels to inches divide by `Figure.dpi`.

"""

if h is None: # Got called with a single pair as argument.

w, h = w

size = np.array([w, h])

if not np.isfinite(size).all() or (size < 0).any():

raise ValueError(f'figure size must be positive finite not {size}')

self.bbox_inches.p1 = size

if forward:

canvas = getattr(self, 'canvas')

if canvas is not None:

dpi_ratio = getattr(canvas, '_dpi_ratio', 1)

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

figure.html

Latest commit

History

figure.html

File metadata and controls