matplotlib.github.com/1.3.1/api/figure_api.html at main · matplotlib/matplotlib.github.com

History

1918 lines (1837 loc) · 143 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>figure — Matplotlib 1.3.1 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.3.1',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.3.1 documentation"

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

</head>

<body>

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

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");

document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));

}

</script>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

piwik_action_name = '';

piwik_idsite = 1;

piwik_url = pkBaseURL + "piwik.php";

piwik_log(piwik_action_name, piwik_idsite, piwik_url);

document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));

}

</script>

</map>

</div>

<h3>Navigation</h3>

<ul>

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

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

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

>modules</a> |</li>

<a href="font_manager_api.html" title="font_manager"

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

<a href="dates_api.html" title="dates"

accesskey="P">previous</a> |</li>

<li><a href="../examples/index.html">examples</a>| </li>

<li><a href="../gallery.html">gallery</a>| </li>

<li><a href="pyplot_summary.html">pyplot</a>| </li>

<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

<h3><a href="../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">figure</a><ul>

<li><a class="reference internal" href="#module-matplotlib.figure"><tt class="docutils literal">matplotlib.figure</tt></a></li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<a href="dates_api.html"

title="previous chapter">dates</a>

<h4>Next topic</h4>

<a href="font_manager_api.html"

title="next chapter">font_manager</a>

<li><a href="../_sources/api/figure_api.txt"

rel="nofollow">Show Source</a></li>

</ul>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</div>

</div>

<h1>figure<a class="headerlink" href="#figure" title="Permalink to this headline">¶</a></h1>

<h2><a class="reference internal" href="#module-matplotlib.figure" title="matplotlib.figure"><tt class="xref py py-mod docutils literal">matplotlib.figure</tt></a><a class="headerlink" href="#module-matplotlib.figure" title="Permalink to this headline">¶</a></h2>

The figure module provides the top-level

<a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal">Artist</tt></a>, the <a class="reference internal" href="#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal">Figure</tt></a>, which

contains all the plot elements. The following classes are defined

<dt><a class="reference internal" href="#matplotlib.figure.SubplotParams" title="matplotlib.figure.SubplotParams"><tt class="xref py py-class docutils literal">SubplotParams</tt></a></dt>

<dd>control the default spacing of the subplots</dd>

<dt><a class="reference internal" href="#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal">Figure</tt></a></dt>

<dd>top level container for all plot elements</dd>

</dl>

class <tt class="descclassname">matplotlib.figure.</tt><tt class="descname">AxesStack</tt><a class="headerlink" href="#matplotlib.figure.AxesStack" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="cbook_api.html#matplotlib.cbook.Stack" title="matplotlib.cbook.Stack"><tt class="xref py py-class docutils literal">matplotlib.cbook.Stack</tt></a>

Specialization of the Stack to handle all tracking of Axes in a Figure.

This stack stores <tt class="docutils literal">key, (ind, axes)</tt> pairs, where:

<li>key should be a hash of the args and kwargs

used in generating the Axes.</li>

<li>ind is a serial number for tracking the order

in which axes were added.</li>

</ul>

</div></blockquote>

The AxesStack is a callable, where <tt class="docutils literal">ax_stack()</tt> returns

the current axes. Alternatively the <a class="reference internal" href="#matplotlib.figure.AxesStack.current_key_axes" title="matplotlib.figure.AxesStack.current_key_axes"><tt class="xref py py-meth docutils literal">current_key_axes()</tt></a> will

return the current key and associated axes.

<dd>Add Axes a, with key key, to the stack, and return the stack.

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

return None.

</dd></dl>

<dd>Return a list of the Axes instances that have been added to the figure

</dd></dl>

<tt class="descname">bubble</tt><big>(</big>a<big>)</big><a class="headerlink" href="#matplotlib.figure.AxesStack.bubble" title="Permalink to this definition">¶</a></dt>

<dd>Move the given axes, which must already exist in the

stack, to the top.

</dd></dl>

<tt class="descname">current_key_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.figure.AxesStack.current_key_axes" title="Permalink to this definition">¶</a></dt>

<dd>Return a tuple of <tt class="docutils literal">(key, axes)</tt> for the active axes.

If no axes exists on the stack, then returns <tt class="docutils literal">(None, None)</tt>.

</dd></dl>

<dd>Return the Axes instance that was added with key.

If it is not present, return None.

</dd></dl>

<tt class="descname">remove</tt><big>(</big>a<big>)</big><a class="headerlink" href="#matplotlib.figure.AxesStack.remove" title="Permalink to this definition">¶</a></dt>

<dd>Remove the axes from the stack.

</dd></dl>

class <tt class="descclassname">matplotlib.figure.</tt><tt class="descname">Figure</tt><big>(</big>figsize=None, dpi=None, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, subplotpars=None, tight_layout=None<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal">matplotlib.artist.Artist</tt></a>

The Figure instance supports callbacks through a callbacks

attribute which is a <a class="reference internal" href="cbook_api.html#matplotlib.cbook.CallbackRegistry" title="matplotlib.cbook.CallbackRegistry"><tt class="xref py py-class docutils literal">matplotlib.cbook.CallbackRegistry</tt></a>

instance. The events you can connect to are ‘dpi_changed’, and

the callback will be called with <tt class="docutils literal">func(fig)</tt> where fig is the

<a class="reference internal" href="#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal">Figure</tt></a> instance.

<dt>patch</dt>

<dd>The figure patch is drawn by a

<a class="reference internal" href="artist_api.html#matplotlib.patches.Rectangle" title="matplotlib.patches.Rectangle"><tt class="xref py py-class docutils literal">matplotlib.patches.Rectangle</tt></a> instance</dd>

<dt>suppressComposite</dt>

<dd>For multiple figure images, the figure will make composite

images depending on the renderer option_image_nocomposite

function. If suppressComposite is True|False, this will

override the renderer.</dd>

<dt>figsize</dt>

<dd>w,h tuple in inches</dd>

<dt>facecolor</dt>

<dd>The figure patch facecolor; defaults to rc <tt class="docutils literal">figure.facecolor</tt></dd>

<dt>edgecolor</dt>

<dd>The figure patch edge color; defaults to rc <tt class="docutils literal">figure.edgecolor</tt></dd>

<dt>linewidth</dt>

<dd>The figure patch edge linewidth; the default linewidth of the frame</dd>

<dt>frameon</dt>

<dd>If False, suppress drawing the figure frame</dd>

<dt>subplotpars</dt>

<dd>A <a class="reference internal" href="#matplotlib.figure.SubplotParams" title="matplotlib.figure.SubplotParams"><tt class="xref py py-class docutils literal">SubplotParams</tt></a> instance, defaults to rc</dd>

<dt>tight_layout</dt>

<dd>If False use subplotpars; if True adjust subplot

parameters using <a class="reference internal" href="#matplotlib.figure.Figure.tight_layout" title="matplotlib.figure.Figure.tight_layout"><tt class="xref py py-meth docutils literal">tight_layout()</tt></a> with default padding.

When providing a dict containing the keys <tt class="xref py py-obj docutils literal">pad</tt>, <tt class="xref py py-obj docutils literal">w_pad</tt>, <tt class="xref py py-obj docutils literal">h_pad</tt>

and <tt class="xref py py-obj docutils literal">rect</tt>, the default <a class="reference internal" href="#matplotlib.figure.Figure.tight_layout" title="matplotlib.figure.Figure.tight_layout"><tt class="xref py py-meth docutils literal">tight_layout()</tt></a> paddings will be

overridden.

Defaults to rc <tt class="docutils literal">figure.autolayout</tt>.</dd>

</dl>

<tt class="descname">add_axes</tt><big>(</big>*args, **kwargs<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.add_axes" title="Permalink to this definition">¶</a></dt>

<dd>Add an axes at position rect [left, bottom, width,

height] where all quantities are in fractions of figure

width and height. kwargs are legal

<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal">Axes</tt></a> kwargs plus projection which

sets the projection type of the axes. (For backward

compatibility, <tt class="docutils literal">polar=True</tt> may also be provided, which is

equivalent to <tt class="docutils literal">projection='polar'</tt>). Valid values for

projection are: [‘aitoff’, ‘hammer’, ‘lambert’, ‘mollweide’, ‘polar’, ‘rectilinear’]. Some of these

projections support additional kwargs, which may be provided

to <a class="reference internal" href="#matplotlib.figure.Figure.add_axes" title="matplotlib.figure.Figure.add_axes"><tt class="xref py py-meth docutils literal">add_axes()</tt></a>. Typical usage:

<div class="highlight-python"><div class="highlight"><pre>rect = l,b,w,h

fig.add_axes(rect)

fig.add_axes(rect, frameon=False, axisbg='g')

fig.add_axes(rect, polar=True)

fig.add_axes(rect, projection='polar')

fig.add_axes(ax)

</pre></div>

</div>

If the figure already has an axes with the same parameters,

then it will simply make that axes current and return it. If

you do not want this behavior, e.g., you want to force the

creation of a new Axes, you must use a unique set of args and

kwargs. The axes <tt class="xref py py-attr docutils literal">label</tt>

attribute has been exposed for this purpose. e.g., if you want

two axes that are otherwise identical to be added to the

figure, make sure you give them unique labels:

<div class="highlight-python"><div class="highlight"><pre>fig.add_axes(rect, label='axes1')

fig.add_axes(rect, label='axes2')

</pre></div>

</div>

In rare circumstances, add_axes may be called with a single

argument, an Axes instance already created in the present

figure but not in the figure’s list of axes. For example,

if an axes has been removed with <a class="reference internal" href="#matplotlib.figure.Figure.delaxes" title="matplotlib.figure.Figure.delaxes"><tt class="xref py py-meth docutils literal">delaxes()</tt></a>, it can

be restored with:

</pre></div>

</div>

In all cases, the <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal">Axes</tt></a> instance

will be returned.

In addition to projection, the following kwargs are supported:

</colgroup>

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

<th class="head">Description</th>

</tr>

</thead>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_adjustable" title="matplotlib.axes.Axes.set_adjustable"><tt class="xref py py-meth docutils literal">adjustable</tt></a></td>

<td>[ ‘box’ | ‘datalim’ | ‘box-forced’]</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><tt class="xref py py-meth docutils literal">agg_filter</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><tt class="xref py py-meth docutils literal">alpha</tt></a></td>

<td>float (0.0 transparent through 1.0 opaque)</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_anchor" title="matplotlib.axes.Axes.set_anchor"><tt class="xref py py-meth docutils literal">anchor</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><tt class="xref py py-meth docutils literal">animated</tt></a></td>

<td>[True | False]</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_aspect" title="matplotlib.axes.Axes.set_aspect"><tt class="xref py py-meth docutils literal">aspect</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_autoscale_on" title="matplotlib.axes.Axes.set_autoscale_on"><tt class="xref py py-meth docutils literal">autoscale_on</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_autoscalex_on" title="matplotlib.axes.Axes.set_autoscalex_on"><tt class="xref py py-meth docutils literal">autoscalex_on</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_autoscaley_on" title="matplotlib.axes.Axes.set_autoscaley_on"><tt class="xref py py-meth docutils literal">autoscaley_on</tt></a></td>

<td>unknown</td>

</tr>

<td>an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal">Axes</tt></a> instance</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_axes_locator" title="matplotlib.axes.Axes.set_axes_locator"><tt class="xref py py-meth docutils literal">axes_locator</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_axis_bgcolor" title="matplotlib.axes.Axes.set_axis_bgcolor"><tt class="xref py py-meth docutils literal">axis_bgcolor</tt></a></td>

<td>any matplotlib color - see <a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.colors" title="matplotlib.pyplot.colors"><tt class="xref py py-func docutils literal">colors()</tt></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_axisbelow" title="matplotlib.axes.Axes.set_axisbelow"><tt class="xref py py-meth docutils literal">axisbelow</tt></a></td>

<td>[ True | False ]</td>

</tr>

<td>a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><tt class="xref py py-class docutils literal">matplotlib.transforms.Bbox</tt></a> instance</td>

</tr>

<td>[True | False]</td>

</tr>

<td>[ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal">Path</tt></a>, <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal">Transform</tt></a>) | <a class="reference internal" href="artist_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><tt class="xref py py-class docutils literal">Patch</tt></a> | None ]</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_color_cycle" title="matplotlib.axes.Axes.set_color_cycle"><tt class="xref py py-meth docutils literal">color_cycle</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><tt class="xref py py-meth docutils literal">contains</tt></a></td>

<td>a callable function</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_figure" title="matplotlib.axes.Axes.set_figure"><tt class="xref py py-meth docutils literal">figure</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_frame_on" title="matplotlib.axes.Axes.set_frame_on"><tt class="xref py py-meth docutils literal">frame_on</tt></a></td>

<td>[ True | False ]</td>

</tr>

<td>an id string</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><tt class="xref py py-meth docutils literal">label</tt></a></td>

<td>string or anything printable with ‘%s’ conversion.</td>

</tr>

<td>[True | False]</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_navigate" title="matplotlib.axes.Axes.set_navigate"><tt class="xref py py-meth docutils literal">navigate</tt></a></td>

<td>[ True | False ]</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_navigate_mode" title="matplotlib.axes.Axes.set_navigate_mode"><tt class="xref py py-meth docutils literal">navigate_mode</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><tt class="xref py py-meth docutils literal">path_effects</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><tt class="xref py py-meth docutils literal">picker</tt></a></td>

<td>[None|float|boolean|callable]</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_position" title="matplotlib.axes.Axes.set_position"><tt class="xref py py-meth docutils literal">position</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_rasterization_zorder" title="matplotlib.axes.Axes.set_rasterization_zorder"><tt class="xref py py-meth docutils literal">rasterization_zorder</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><tt class="xref py py-meth docutils literal">rasterized</tt></a></td>

<td>[True | False | None]</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><tt class="xref py py-meth docutils literal">sketch_params</tt></a></td>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_title" title="matplotlib.axes.Axes.set_title"><tt class="xref py py-meth docutils literal">title</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><tt class="xref py py-meth docutils literal">transform</tt></a></td>

<td><a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal">Transform</tt></a> instance</td>

</tr>

<td>a url string</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><tt class="xref py py-meth docutils literal">visible</tt></a></td>

<td>[True | False]</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_xbound" title="matplotlib.axes.Axes.set_xbound"><tt class="xref py py-meth docutils literal">xbound</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_xlabel" title="matplotlib.axes.Axes.set_xlabel"><tt class="xref py py-meth docutils literal">xlabel</tt></a></td>

<td>unknown</td>

</tr>

<td>length 2 sequence of floats</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_xmargin" title="matplotlib.axes.Axes.set_xmargin"><tt class="xref py py-meth docutils literal">xmargin</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_xscale" title="matplotlib.axes.Axes.set_xscale"><tt class="xref py py-meth docutils literal">xscale</tt></a></td>

<td>[‘linear’ | ‘log’ | ‘symlog’]</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_xticklabels" title="matplotlib.axes.Axes.set_xticklabels"><tt class="xref py py-meth docutils literal">xticklabels</tt></a></td>

<td>sequence of strings</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_xticks" title="matplotlib.axes.Axes.set_xticks"><tt class="xref py py-meth docutils literal">xticks</tt></a></td>

<td>sequence of floats</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_ybound" title="matplotlib.axes.Axes.set_ybound"><tt class="xref py py-meth docutils literal">ybound</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_ylabel" title="matplotlib.axes.Axes.set_ylabel"><tt class="xref py py-meth docutils literal">ylabel</tt></a></td>

<td>unknown</td>

</tr>

<td>length 2 sequence of floats</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_ymargin" title="matplotlib.axes.Axes.set_ymargin"><tt class="xref py py-meth docutils literal">ymargin</tt></a></td>

<td>unknown</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_yscale" title="matplotlib.axes.Axes.set_yscale"><tt class="xref py py-meth docutils literal">yscale</tt></a></td>

<td>[‘linear’ | ‘log’ | ‘symlog’]</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_yticklabels" title="matplotlib.axes.Axes.set_yticklabels"><tt class="xref py py-meth docutils literal">yticklabels</tt></a></td>

<td>sequence of strings</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.set_yticks" title="matplotlib.axes.Axes.set_yticks"><tt class="xref py py-meth docutils literal">yticks</tt></a></td>

<td>sequence of floats</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><tt class="xref py py-meth docutils literal">zorder</tt></a></td>

<td>any number</td>

</tr>

</tbody>

</table>

</div></blockquote>

</dd></dl>

<tt class="descname">add_axobserver</tt><big>(</big>func<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.add_axobserver" title="Permalink to this definition">¶</a></dt>

<dd>whenever the axes state change, <tt class="docutils literal">func(self)</tt> will be called

</dd></dl>

<tt class="descname">add_subplot</tt><big>(</big>*args, **kwargs<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.add_subplot" title="Permalink to this definition">¶</a></dt>

<dd>Add a subplot. Examples:

<div class="highlight-python"><div class="highlight"><pre>fig.add_subplot(111)

# equivalent but more general

fig.add_subplot(1,1,1)

# add subplot with red background

fig.add_subplot(212, axisbg='r')

# add a polar subplot

fig.add_subplot(111, projection='polar')

# add Subplot instance sub

fig.add_subplot(sub)

</pre></div>

</div>

kwargs are legal <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal">Axes</tt></a> kwargs plus

projection, which chooses a projection type for the axes.

(For backward compatibility, polar=True may also be

provided, which is equivalent to projection=’polar’). Valid

values for projection are: [‘aitoff’, ‘hammer’, ‘lambert’, ‘mollweide’, ‘polar’, ‘rectilinear’]. Some of

these projections

support additional kwargs, which may be provided to

<a class="reference internal" href="#matplotlib.figure.Figure.add_axes" title="matplotlib.figure.Figure.add_axes"><tt class="xref py py-meth docutils literal">add_axes()</tt></a>.

The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal">Axes</tt></a> instance will be returned.

If the figure already has a subplot with key (args,

kwargs) then it will simply make that subplot current and

return it.

The following kwargs are supported:

</colgroup>

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

<th class="head">Description</th>

</tr>

</thead>

<td>[ ‘box’ | ‘datalim’ | ‘box-forced’]</td>

</tr>

<td>unknown</td>

</tr>

<td>float (0.0 transparent through 1.0 opaque)</td>

</tr>

<td>unknown</td>

</tr>

<td>[True | False]</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>[ True | False ]</td>

</tr>

<td>[True | False]</td>

</tr>

<td>unknown</td>

</tr>

<td>a callable function</td>

</tr>

<td>unknown</td>

</tr>

<td>[ True | False ]</td>

</tr>

<td>an id string</td>

</tr>

<td>string or anything printable with ‘%s’ conversion.</td>

</tr>

<td>[True | False]</td>

</tr>

<td>[ True | False ]</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>[None|float|boolean|callable]</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>[True | False | None]</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>a url string</td>

</tr>

<td>[True | False]</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>length 2 sequence of floats</td>

</tr>

<td>unknown</td>

</tr>

<td>[‘linear’ | ‘log’ | ‘symlog’]</td>

</tr>

<td>sequence of strings</td>

</tr>

<td>sequence of floats</td>

</tr>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

<td>length 2 sequence of floats</td>

</tr>

<td>unknown</td>

</tr>

<td>[‘linear’ | ‘log’ | ‘symlog’]</td>

</tr>

<td>sequence of strings</td>

</tr>

<td>sequence of floats</td>

</tr>

<td>any number</td>

</tr>

</tbody>

</table>

</div></blockquote>

</dd></dl>

<tt class="descname">autofmt_xdate</tt><big>(</big>bottom=0.2, rotation=30, ha='right'<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.autofmt_xdate" title="Permalink to this definition">¶</a></dt>

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

<dt>bottom</dt>

<dd>The bottom of the subplots for <a class="reference internal" href="#matplotlib.figure.Figure.subplots_adjust" title="matplotlib.figure.Figure.subplots_adjust"><tt class="xref py py-meth docutils literal">subplots_adjust()</tt></a></dd>

<dt>rotation</dt>

<dd>The rotation of the xtick labels</dd>

<dd>The horizontal alignment of the xticklabels</dd>

</dl>

</dd></dl>

<dd>Read-only: list of axes in Figure

</dd></dl>

<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.clear" title="Permalink to this definition">¶</a></dt>

<dd>Clear the figure – synonym for <a class="reference internal" href="#matplotlib.figure.Figure.clf" title="matplotlib.figure.Figure.clf"><tt class="xref py py-meth docutils literal">clf()</tt></a>.

</dd></dl>

<tt class="descname">clf</tt><big>(</big>keep_observers=False<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.clf" title="Permalink to this definition">¶</a></dt>

<dd>Clear the figure.

Set keep_observers to True if, for example,

a gui widget is tracking the axes in the figure.

</dd></dl>

<tt class="descname">colorbar</tt><big>(</big>mappable, cax=None, ax=None, use_gridspec=True, **kw<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.colorbar" title="Permalink to this definition">¶</a></dt>

<dd>Create a colorbar for a ScalarMappable instance, mappable.

Documentation for the pylab thin wrapper:

Add a colorbar to a plot.

Function signatures for the <a class="reference internal" href="pyplot_api.html#module-matplotlib.pyplot" title="matplotlib.pyplot"><tt class="xref py py-mod docutils literal">pyplot</tt></a> interface; all

but the first are also method signatures for the

<a class="reference internal" href="#matplotlib.figure.Figure.colorbar" title="matplotlib.figure.Figure.colorbar"><tt class="xref py py-meth docutils literal">colorbar()</tt></a> method:

<div class="highlight-python"><div class="highlight"><pre>colorbar(**kwargs)

colorbar(mappable, **kwargs)

colorbar(mappable, cax=cax, **kwargs)

colorbar(mappable, ax=ax, **kwargs)

</pre></div>

</div>

arguments:

<dt>mappable</dt>

<dd>the <tt class="xref py py-class docutils literal">Image</tt>,

<tt class="xref py py-class docutils literal">ContourSet</tt>, etc. to

which the colorbar applies; this argument is mandatory for the

<a class="reference internal" href="pyplot_api.html#matplotlib.pyplot.colorbar" title="matplotlib.pyplot.colorbar"><tt class="xref py py-func docutils literal">colorbar()</tt></a> function, which sets the

default to the current image.</dd>

</dl>

</div></blockquote>

keyword arguments:

<dd>None | axes object into which the colorbar will be drawn</dd>

<dd>None | parent axes object(s) from which space for a new

colorbar axes will be stolen. If a list of axes is given

they will all be resized to make room for the colorbar axes.</dd>

<dt>use_gridspec</dt>

<dd>False | If cax is None, a new cax is created as an instance of

Axes. If ax is an instance of Subplot and use_gridspec is True,

cax is created as an instance of Subplot using the

grid_spec module.</dd>

</dl>

</div></blockquote>

Additional keyword arguments are of two kinds:

<div>axes properties:

</colgroup>

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

<th class="head">Description</th>

</tr>

</thead>

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

<td>vertical or horizontal</td>

</tr>

<tr class="row-odd"><td>fraction</td>

<td>0.15; fraction of original axes to use for colorbar</td>

</tr>

<td>0.05 if vertical, 0.15 if horizontal; fraction

of original axes between colorbar and new image axes</td>

</tr>

<tr class="row-odd"><td>shrink</td>

<td>1.0; fraction by which to shrink the colorbar</td>

</tr>

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

<td>20; ratio of long to short dimensions</td>

</tr>

<tr class="row-odd"><td>anchor</td>

<td>(0.0, 0.5) if vertical; (0.5, 1.0) if horizontal;

the anchor point of the colorbar axes</td>

</tr>

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

<td>(1.0, 0.5) if vertical; (0.5, 0.0) if horizontal;

the anchor point of the colorbar parent axes. If

False, the parent axes’ anchor will be unchanged</td>

</tr>

</tbody>

</table>

</div></blockquote>

colorbar properties:

</colgroup>

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

<th class="head">Description</th>

</tr>

</thead>

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

<td>[ ‘neither’ | ‘both’ | ‘min’ | ‘max’ ]

If not ‘neither’, make pointed end(s) for out-of-

range values. These are set for a given colormap

using the colormap set_under and set_over methods.</td>

</tr>

<tr class="row-odd"><td>extendfrac</td>

<td>[ None | ‘auto’ | length | lengths ]

If set to None, both the minimum and maximum

triangular colorbar extensions with have a length of

5% of the interior colorbar length (this is the

default setting). If set to ‘auto’, makes the

triangular colorbar extensions the same lengths as

the interior boxes (when spacing is set to

‘uniform’) or the same lengths as the respective

adjacent interior boxes (when spacing is set to

‘proportional’). If a scalar, indicates the length

of both the minimum and maximum triangular colorbar

extensions as a fraction of the interior colorbar

length. A two-element sequence of fractions may also

be given, indicating the lengths of the minimum and

maximum colorbar extensions respectively as a

fraction of the interior colorbar length.</td>

</tr>

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

<td>[ False | True ]

If False the minimum and maximum colorbar extensions

will be triangular (the default). If True the

extensions will be rectangular.</td>

</tr>

<tr class="row-odd"><td>spacing</td>

<td>[ ‘uniform’ | ‘proportional’ ]

Uniform spacing gives each discrete color the same

space; proportional makes the space proportional to

the data interval.</td>

</tr>

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

<td>[ None | list of ticks | Locator object ]

If None, ticks are determined automatically from the

input.</td>

</tr>

<tr class="row-odd"><td>format</td>

<td>[ None | format string | Formatter object ]

If None, the

<a class="reference internal" href="ticker_api.html#matplotlib.ticker.ScalarFormatter" title="matplotlib.ticker.ScalarFormatter"><tt class="xref py py-class docutils literal">ScalarFormatter</tt></a> is used.

If a format string is given, e.g., ‘%.3f’, that is

used. An alternative

<a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><tt class="xref py py-class docutils literal">Formatter</tt></a> object may be

given instead.</td>

</tr>

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

<td>[ False | True ] If true, draw lines at color

boundaries.</td>

</tr>

</tbody>

</table>

The following will probably be useful only in the context of

indexed colors (that is, when the mappable has norm=NoNorm()),

or other unusual circumstances.

</colgroup>

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

<th class="head">Description</th>

</tr>

</thead>

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

<td>None or a sequence</td>

</tr>

<tr class="row-odd"><td>values</td>

<td>None or a sequence which must be of length 1 less

than the sequence of boundaries. For each region

delimited by adjacent entries in boundaries, the

color mapped to the corresponding value in values

will be used.</td>

</tr>

</tbody>

</table>

</div></blockquote>

If mappable is a <tt class="xref py py-class docutils literal">ContourSet</tt>, its extend

kwarg is included automatically.

Note that the shrink kwarg provides a simple way to keep a vertical

colorbar, for example, from being taller than the axes of the mappable

to which the colorbar is attached; but it is a manual method requiring

some trial and error. If the colorbar is too tall (or a horizontal

colorbar is too wide) use a smaller value of shrink.

For more precise control, you can manually specify the positions of

the axes objects in which the mappable and the colorbar are drawn. In

this case, do not use any of the axes properties kwargs.

It is known that some vector graphics viewer (svg and pdf) renders white gaps

between segments of the colorbar. This is due to bugs in the viewers not

matplotlib. As a workaround the colorbar can be rendered with overlapping

segments:

<div class="highlight-python"><div class="highlight"><pre>cbar = colorbar()

cbar.solids.set_edgecolor("face")

draw()

</pre></div>

</div>

However this has negative consequences in other circumstances. Particularly

with semi transparent images (alpha < 1) and colorbar extensions and is not

enabled by default see (issue #1188).

<dt>returns:</dt>

<dd><a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.Colorbar" title="matplotlib.colorbar.Colorbar"><tt class="xref py py-class docutils literal">Colorbar</tt></a> instance; see also its base class,

<a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.ColorbarBase" title="matplotlib.colorbar.ColorbarBase"><tt class="xref py py-class docutils literal">ColorbarBase</tt></a>. Call the

<a class="reference internal" href="colorbar_api.html#matplotlib.colorbar.ColorbarBase.set_label" title="matplotlib.colorbar.ColorbarBase.set_label"><tt class="xref py py-meth docutils literal">set_label()</tt></a> method

to label the colorbar.</dd>

</dl>

</dd></dl>

<tt class="descname">contains</tt><big>(</big>mouseevent<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.contains" title="Permalink to this definition">¶</a></dt>

<dd>Test whether the mouse event occurred on the figure.

Returns True,{}

</dd></dl>

<tt class="descname">delaxes</tt><big>(</big>a<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.delaxes" title="Permalink to this definition">¶</a></dt>

<dd>remove a from the figure and update the current axes

</dd></dl>

<tt class="descname">draw</tt><big>(</big>artist, renderer, *args, **kwargs<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.draw" title="Permalink to this definition">¶</a></dt>

<dd>Render the figure using <a class="reference internal" href="backend_bases_api.html#matplotlib.backend_bases.RendererBase" title="matplotlib.backend_bases.RendererBase"><tt class="xref py py-class docutils literal">matplotlib.backend_bases.RendererBase</tt></a>

instance renderer.

</dd></dl>

<tt class="descname">draw_artist</tt><big>(</big>a<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.draw_artist" title="Permalink to this definition">¶</a></dt>

<dd>draw <a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><tt class="xref py py-class docutils literal">matplotlib.artist.Artist</tt></a> instance a only –

this is available only after the figure is drawn

</dd></dl>

<tt class="descname">figimage</tt><big>(</big>X, xo=0, yo=0, alpha=None, norm=None, cmap=None, vmin=None, vmax=None, origin=None, **kwargs<big>)</big><a class="headerlink" href="#matplotlib.figure.Figure.figimage" title="Permalink to this definition">¶</a></dt>

<dd>Adds a non-resampled image to the figure.

call signatures:

<div class="highlight-python"><div class="highlight"><pre>figimage(X, **kwargs)

</pre></div>

</div>

adds a non-resampled array X to the figure.

<div class="highlight-python"><div class="highlight"><pre>figimage(X, xo, yo)

</pre></div>

</div>

with pixel offsets xo, yo,

X must be a float array:

<li>If X is MxN, assume luminance (grayscale)</li>

<li>If X is MxNx3, assume RGB</li>

<li>If X is MxNx4, assume RGBA</li>

</ul>

Optional keyword arguments:

</colgroup>

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

<th class="head">Description</th>

</tr>

</thead>

<td>An integer, the x and y image offset in pixels</td>

</tr>

<td>a <a class="reference internal" href="colors_api.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><tt class="xref py py-class docutils literal">matplotlib.colors.Colormap</tt></a> instance, eg

cm.jet. If None, default to the rc <tt class="docutils literal">image.cmap</tt>

value</td>

</tr>

<td>a <a class="reference internal" href="colors_api.html#matplotlib.colors.Normalize" title="matplotlib.colors.Normalize"><tt class="xref py py-class docutils literal">matplotlib.colors.Normalize</tt></a> instance. The

default is normalization(). This scales luminance -> 0-1</td>

</tr>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

figure_api.html

Latest commit

History

figure_api.html

File metadata and controls