matplotlib.github.com/2.0.0/api/offsetbox_api.html at plausible · matplotlib/matplotlib.github.com · GitHub

History

1080 lines (947 loc) · 64.7 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>offsetbox — Matplotlib 2.0.0 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.0.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.0.0 documentation"

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

</head>

<body>

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

</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="patches_api.html" title="patches"

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

<a href="mlab_api.html" title="mlab"

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>

</a>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

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

<ul>

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

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

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

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

<li><a href="index.html">The Matplotlib API</a><ul>

<li>Previous: <a href="mlab_api.html" title="previous chapter">mlab</a></li>

<li>Next: <a href="patches_api.html" title="next chapter">patches</a></li>

</ul></li>

</ul>

</div>

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

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

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

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

The OffsetBox is a simple container artist. The child artist are meant

to be drawn at a relative position to its parent. The [VH]Packer,

DrawingArea and TextArea are derived from the OffsetBox.

The [VH]Packer automatically adjust the relative postisions of their

children, which should be instances of the OffsetBox. This is used to

align similar artists together, e.g., in legend.

The DrawingArea can contain any Artist as a child. The

DrawingArea has a fixed width and height. The position of children

relative to the parent is fixed. The TextArea is contains a single

Text instance. The width and height of the TextArea instance is the

width and height of the its child text.

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">AnchoredOffsetbox</code>(loc, pad=0.4, borderpad=0.5, child=None, prop=None, frameon=True, bbox_to_anchor=None, bbox_transform=None, **kwargs)<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><code class="xref py py-class docutils literal">matplotlib.offsetbox.OffsetBox</code></a>

An offset box placed according to the legend location

loc. AnchoredOffsetbox has a single child. When multiple children

is needed, use other OffsetBox class to enclose them. By default,

the offset box is anchored against its parent axes. You may

explicitly specify the bbox_to_anchor.

loc is a string or an integer specifying the legend location.

The valid location codes are:

<div class="highlight-default"><div class="highlight"><pre>'upper right' : 1,

'upper left' : 2,

'lower left' : 3,

'lower right' : 4,

'right' : 5,

'center left' : 6,

'center right' : 7,

'lower center' : 8,

'upper center' : 9,

'center' : 10,

</pre></div>

</div>

<dt>pad : pad around the child for drawing a frame. given in</dt>

<dd>fraction of fontsize.</dd>

</dl>

borderpad : pad between offsetbox frame and the bbox_to_anchor,

child : OffsetBox instance that will be anchored.

prop : font property. This is only used as a reference for paddings.

frameon : draw a frame box if True.

bbox_to_anchor : bbox to anchor. Use self.axes.bbox if None.

bbox_transform : with which the bbox_to_anchor will be transformed.

<code class="descname">draw</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.draw" title="Permalink to this definition">¶</a></dt>

<dd>draw the artist

</dd></dl>

<code class="descname">get_bbox_to_anchor</code>()<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_bbox_to_anchor" title="Permalink to this definition">¶</a></dt>

<dd>return the bbox that the legend will be anchored

</dd></dl>

<code class="descname">get_child</code>()<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_child" title="Permalink to this definition">¶</a></dt>

<dd>return the child

</dd></dl>

<code class="descname">get_children</code>()<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_children" title="Permalink to this definition">¶</a></dt>

<dd>return the list of children

</dd></dl>

<code class="descname">get_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_extent" title="Permalink to this definition">¶</a></dt>

<dd>return the extent of the artist. The extent of the child

added with the pad is returned

</dd></dl>

<code class="descname">get_window_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_window_extent" title="Permalink to this definition">¶</a></dt>

<dd>get the bounding box in display space.

</dd></dl>

<code class="descname">set_bbox_to_anchor</code>(bbox, transform=None)<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.set_bbox_to_anchor" title="Permalink to this definition">¶</a></dt>

<dd>set the bbox that the child will be anchored.

bbox can be a Bbox instance, a list of [left, bottom, width,

height], or a list of [left, bottom] where the width and

height will be assumed to be zero. The bbox will be

transformed to display coordinate by the given transform.

</dd></dl>

<code class="descname">set_child</code>(child)<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.set_child" title="Permalink to this definition">¶</a></dt>

<dd>set the child to be anchored

</dd></dl>

<code class="descname">update_frame</code>(bbox, fontsize=None)<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.update_frame" title="Permalink to this definition">¶</a></dt>

<code class="descname">zorder</code> = 5<a class="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.zorder" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">AnchoredText</code>(s, loc, pad=0.4, borderpad=0.5, prop=None, **kwargs)<a class="headerlink" href="#matplotlib.offsetbox.AnchoredText" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.offsetbox.AnchoredOffsetbox" title="matplotlib.offsetbox.AnchoredOffsetbox"><code class="xref py py-class docutils literal">matplotlib.offsetbox.AnchoredOffsetbox</code></a>

AnchoredOffsetbox with Text.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">s : string

<div>Text.

</div></blockquote>

loc : str

<div>Location code.

</div></blockquote>

pad : float, optional

<div>Pad between the text and the frame as fraction of the font

size.

</div></blockquote>

borderpad : float, optional

<div>Pad between the frame and the axes (or bbox_to_anchor).

</div></blockquote>

prop : <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal">matplotlib.font_manager.FontProperties</code></a>

<div>Font properties.

</div></blockquote>

</td>

</tr>

</tbody>

</table>

Notes

Other keyword parameters of <a class="reference internal" href="#matplotlib.offsetbox.AnchoredOffsetbox" title="matplotlib.offsetbox.AnchoredOffsetbox"><code class="xref py py-obj docutils literal">AnchoredOffsetbox</code></a> are also

allowed.

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">AnnotationBbox</code>(offsetbox, xy, xybox=None, xycoords='data', boxcoords=None, frameon=True, pad=0.4, annotation_clip=None, box_alignment=(0.5, 0.5), bboxprops=None, arrowprops=None, fontsize=None, **kwargs)<a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal">matplotlib.artist.Artist</code>, <code class="xref py py-class docutils literal">matplotlib.text._AnnotationBase</code>

Annotation-like class, but with offsetbox instead of Text.

offsetbox : OffsetBox instance

<dt>xycoords : same as Annotation but can be a tuple of two</dt>

<dd>strings which are interpreted as x and y coordinates.</dd>

<dt>boxcoords : similar to textcoords as Annotation but can be a</dt>

<dd>tuple of two strings which are interpreted as x and y

coordinates.</dd>

<dt>box_alignment : a tuple of two floats for a vertical and</dt>

<dd>horizontal alignment of the offset box w.r.t. the boxcoords.

The lower-left corner is (0.0) and upper-right corner is (1.1).</dd>

</dl>

other parameters are identical to that of Annotation.

<code class="descname">anncoords</code><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.anncoords" title="Permalink to this definition">¶</a></dt>

<code class="descname">contains</code>(event)<a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.contains" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.draw" title="Permalink to this definition">¶</a></dt>

<dd>Draw the <code class="xref py py-class docutils literal">Annotation</code> object to the given renderer.

</dd></dl>

<code class="descname">get_children</code>()<a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.get_children" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_fontsize</code>(s=None)<a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.get_fontsize" title="Permalink to this definition">¶</a></dt>

<dd>return fontsize in points

</dd></dl>

<code class="descname">set_figure</code>(fig)<a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.set_figure" title="Permalink to this definition">¶</a></dt>

<code class="descname">set_fontsize</code>(s=None)<a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.set_fontsize" title="Permalink to this definition">¶</a></dt>

<dd>set fontsize in points

</dd></dl>

<code class="descname">update_positions</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.update_positions" title="Permalink to this definition">¶</a></dt>

<dd>Update the pixel positions of the annotated point and the text.

</dd></dl>

<code class="descname">xyann</code><a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.xyann" title="Permalink to this definition">¶</a></dt>

<code class="descname">zorder</code> = 3<a class="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.zorder" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">AuxTransformBox</code>(aux_transform)<a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox" title="Permalink to this definition">¶</a></dt>

Offset Box with the aux_transform . Its children will be

transformed with the aux_transform first then will be

offseted. The absolute coordinate of the aux_transform is meaning

as it will be automatically adjust so that the left-lower corner

of the bounding box of children will be set to (0,0) before the

offset transform.

It is similar to drawing area, except that the extent of the box

is not predetermined but calculated from the window extent of its

children. Furthermore, the extent of the children will be

calculated in the transformed coordinate.

<code class="descname">add_artist</code>(a)<a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.add_artist" title="Permalink to this definition">¶</a></dt>

<dd>Add any <code class="xref py py-class docutils literal">Artist</code> to the container box

</dd></dl>

<code class="descname">draw</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.draw" title="Permalink to this definition">¶</a></dt>

<dd>Draw the children

</dd></dl>

<code class="descname">get_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_extent" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_offset</code>()<a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_offset" title="Permalink to this definition">¶</a></dt>

<dd>return offset of the container.

</dd></dl>

<code class="descname">get_transform</code>()<a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_transform" title="Permalink to this definition">¶</a></dt>

<dd>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal">Transform</code></a> applied

to the children

</dd></dl>

<code class="descname">get_window_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_window_extent" title="Permalink to this definition">¶</a></dt>

<dd>get the bounding box in display space.

</dd></dl>

<code class="descname">set_offset</code>(xy)<a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.set_offset" title="Permalink to this definition">¶</a></dt>

<dd>set offset of the container.

Accept : tuple of x,y coordinate in disokay units.

</dd></dl>

<code class="descname">set_transform</code>(t)<a class="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.set_transform" title="Permalink to this definition">¶</a></dt>

<dd>set_transform is ignored.

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">DraggableAnnotation</code>(annotation, use_blit=False)<a class="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.offsetbox.DraggableBase" title="matplotlib.offsetbox.DraggableBase"><code class="xref py py-class docutils literal">matplotlib.offsetbox.DraggableBase</code></a>

<code class="descname">save_offset</code>()<a class="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation.save_offset" title="Permalink to this definition">¶</a></dt>

<code class="descname">update_offset</code>(dx, dy)<a class="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation.update_offset" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">DraggableBase</code>(ref_artist, use_blit=False)<a class="headerlink" href="#matplotlib.offsetbox.DraggableBase" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal">object</code>

helper code for a draggable artist (legend, offsetbox)

The derived class must override following two method.

<dt>def saveoffset(self):</dt>

<dt>def update_offset(self, dx, dy):</dt>

</dl>

</div></blockquote>

saveoffset is called when the object is picked for dragging and it is

meant to save reference position of the artist.

<dt>update_offset is called during the dragging. dx and dy is the pixel</dt>

<dd>offset from the point where the mouse drag started.</dd>

</dl>

Optionally you may override following two methods.

<dt>def artist_picker(self, artist, evt):</dt>

<dd>return self.ref_artist.contains(evt)</dd>

<dt>def finalize_offset(self):</dt>

</dl>

</div></blockquote>

<dt>artist_picker is a picker method that will be</dt>

<dd>used. finalize_offset is called when the mouse is released. In

current implementaion of DraggableLegend and DraggableAnnotation,

update_offset places the artists simply in display

coordinates. And finalize_offset recalculate their position in

the normalized axes coordinate and set a relavant attribute.</dd>

</dl>

<code class="descname">artist_picker</code>(artist, evt)<a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.artist_picker" title="Permalink to this definition">¶</a></dt>

<code class="descname">disconnect</code>()<a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.disconnect" title="Permalink to this definition">¶</a></dt>

<dd>disconnect the callbacks

</dd></dl>

<code class="descname">finalize_offset</code>()<a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.finalize_offset" title="Permalink to this definition">¶</a></dt>

<code class="descname">on_motion</code>(evt)<a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_motion" title="Permalink to this definition">¶</a></dt>

<code class="descname">on_motion_blit</code>(evt)<a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_motion_blit" title="Permalink to this definition">¶</a></dt>

<code class="descname">on_release</code>(event)<a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_release" title="Permalink to this definition">¶</a></dt>

<code class="descname">save_offset</code>()<a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.save_offset" title="Permalink to this definition">¶</a></dt>

<code class="descname">update_offset</code>(dx, dy)<a class="headerlink" href="#matplotlib.offsetbox.DraggableBase.update_offset" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">DraggableOffsetBox</code>(ref_artist, offsetbox, use_blit=False)<a class="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_loc_in_canvas</code>()<a class="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox.get_loc_in_canvas" title="Permalink to this definition">¶</a></dt>

<code class="descname">save_offset</code>()<a class="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox.save_offset" title="Permalink to this definition">¶</a></dt>

<code class="descname">update_offset</code>(dx, dy)<a class="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox.update_offset" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">DrawingArea</code>(width, height, xdescent=0.0, ydescent=0.0, clip=False)<a class="headerlink" href="#matplotlib.offsetbox.DrawingArea" title="Permalink to this definition">¶</a></dt>

The DrawingArea can contain any Artist as a child. The DrawingArea

has a fixed width and height. The position of children relative to

the parent is fixed. The children can be clipped at the

boundaries of the parent.

width, height : width and height of the container box.

xdescent, ydescent : descent of the box in x- and y-direction.

clip : Whether to clip the children

<code class="descname">add_artist</code>(a)<a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.add_artist" title="Permalink to this definition">¶</a></dt>

<dd>Add any <code class="xref py py-class docutils literal">Artist</code> to the container box

</dd></dl>

<code class="descname">clip_children</code><a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.clip_children" title="Permalink to this definition">¶</a></dt>

<dd>If the children of this DrawingArea should be clipped

by DrawingArea bounding box.

</dd></dl>

<code class="descname">draw</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.draw" title="Permalink to this definition">¶</a></dt>

<dd>Draw the children

</dd></dl>

<code class="descname">get_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_extent" title="Permalink to this definition">¶</a></dt>

<dd>Return with, height, xdescent, ydescent of box

</dd></dl>

<code class="descname">get_offset</code>()<a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_offset" title="Permalink to this definition">¶</a></dt>

<dd>return offset of the container.

</dd></dl>

<code class="descname">get_transform</code>()<a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_transform" title="Permalink to this definition">¶</a></dt>

to the children

</dd></dl>

<code class="descname">get_window_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_window_extent" title="Permalink to this definition">¶</a></dt>

<dd>get the bounding box in display space.

</dd></dl>

<code class="descname">set_offset</code>(xy)<a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.set_offset" title="Permalink to this definition">¶</a></dt>

<dd>set offset of the container.

Accept : tuple of x,y cooridnate in disokay units.

</dd></dl>

<code class="descname">set_transform</code>(t)<a class="headerlink" href="#matplotlib.offsetbox.DrawingArea.set_transform" title="Permalink to this definition">¶</a></dt>

<dd>set_transform is ignored.

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">HPacker</code>(pad=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)<a class="headerlink" href="#matplotlib.offsetbox.HPacker" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.offsetbox.PackerBase" title="matplotlib.offsetbox.PackerBase"><code class="xref py py-class docutils literal">matplotlib.offsetbox.PackerBase</code></a>

The HPacker has its children packed horizontally. It automatically

adjusts the relative positions of children at draw time.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">pad : float, optional

<div>Boundary pad.

</div></blockquote>

sep : float, optional

<div>Spacing between items.

</div></blockquote>

width : float, optional

height : float, optional

<div>Width and height of the container box, calculated if

<code class="xref py py-obj docutils literal">None</code>.

</div></blockquote>

align : str

<div>Alignment of boxes.

</div></blockquote>

mode : str

<div>Packing mode.

</div></blockquote>

</td>

</tr>

</tbody>

</table>

Notes

pad and sep need to given in points and will be scale with

the renderer dpi, while width and height need to be in

pixels.

<code class="descname">get_extent_offsets</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.HPacker.get_extent_offsets" title="Permalink to this definition">¶</a></dt>

<dd>update offset of children and return the extents of the box

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">OffsetBox</code>(*args, **kwargs)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal">matplotlib.artist.Artist</code>

The OffsetBox is a simple container artist. The child artist are meant

to be drawn at a relative position to its parent.

<dd>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal">Axes</code></a> instance the artist

resides in, or None.

</dd></dl>

<code class="descname">contains</code>(mouseevent)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.contains" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.draw" title="Permalink to this definition">¶</a></dt>

<dd>Update the location of children if necessary and draw them

to the given renderer.

</dd></dl>

<code class="descname">get_children</code>()<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_children" title="Permalink to this definition">¶</a></dt>

<dd>Return a list of artists it contains.

</dd></dl>

<code class="descname">get_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_extent" title="Permalink to this definition">¶</a></dt>

<dd>Return with, height, xdescent, ydescent of box

</dd></dl>

<code class="descname">get_extent_offsets</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_extent_offsets" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_offset</code>(width, height, xdescent, ydescent, renderer)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_offset" title="Permalink to this definition">¶</a></dt>

<dd>Get the offset

accepts extent of the box

</dd></dl>

<code class="descname">get_visible_children</code>()<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_visible_children" title="Permalink to this definition">¶</a></dt>

<dd>Return a list of visible artists it contains.

</dd></dl>

<code class="descname">get_window_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_window_extent" title="Permalink to this definition">¶</a></dt>

<dd>get the bounding box in display space.

</dd></dl>

<code class="descname">set_figure</code>(fig)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_figure" title="Permalink to this definition">¶</a></dt>

<dd>Set the figure

accepts a class:<a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal">Figure</code></a> instance

</dd></dl>

<code class="descname">set_height</code>(height)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_height" title="Permalink to this definition">¶</a></dt>

<dd>Set the height

accepts float

</dd></dl>

<code class="descname">set_offset</code>(xy)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_offset" title="Permalink to this definition">¶</a></dt>

<dd>Set the offset

accepts x, y, tuple, or a callable object.

</dd></dl>

<code class="descname">set_width</code>(width)<a class="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_width" title="Permalink to this definition">¶</a></dt>

<dd>Set the width

accepts float

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">OffsetImage</code>(arr, zoom=1, cmap=None, norm=None, interpolation=None, origin=None, filternorm=1, filterrad=4.0, resample=False, dpi_cor=True, **kwargs)<a class="headerlink" href="#matplotlib.offsetbox.OffsetImage" title="Permalink to this definition">¶</a></dt>

<code class="descname">draw</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.draw" title="Permalink to this definition">¶</a></dt>

<dd>Draw the children

</dd></dl>

<code class="descname">get_children</code>()<a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_children" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_extent" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_offset</code>()<a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_offset" title="Permalink to this definition">¶</a></dt>

<dd>return offset of the container.

</dd></dl>

<code class="descname">get_window_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_window_extent" title="Permalink to this definition">¶</a></dt>

<dd>get the bounding box in display space.

</dd></dl>

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">PackerBase</code>(pad=None, sep=None, width=None, height=None, align=None, mode=None, children=None)<a class="headerlink" href="#matplotlib.offsetbox.PackerBase" title="Permalink to this definition">¶</a></dt>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">pad : float, optional

<div>Boundary pad.

</div></blockquote>

sep : float, optional

<div>Spacing between items.

</div></blockquote>

width : float, optional

height : float, optional

<div>Width and height of the container box, calculated if

<code class="xref py py-obj docutils literal">None</code>.

</div></blockquote>

align : str, optional

<div>Alignment of boxes. Can be one of <code class="docutils literal">top</code>, <code class="docutils literal">bottom</code>,

<code class="docutils literal">left</code>, <code class="docutils literal">right</code>, <code class="docutils literal">center</code> and <code class="docutils literal">baseline</code>

</div></blockquote>

mode : str, optional

<div>Packing mode.

</div></blockquote>

</td>

</tr>

</tbody>

</table>

Notes

pad and sep need to given in points and will be scale with

the renderer dpi, while width and height need to be in

pixels.

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">PaddedBox</code>(child, pad=None, draw_frame=False, patch_attrs=None)<a class="headerlink" href="#matplotlib.offsetbox.PaddedBox" title="Permalink to this definition">¶</a></dt>

pad : boundary pad

Note

pad need to given in points and will be

scale with the renderer dpi, while width and height

need to be in pixels.

</div>

<code class="descname">draw</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.PaddedBox.draw" title="Permalink to this definition">¶</a></dt>

<dd>Update the location of children if necessary and draw them

to the given renderer.

</dd></dl>

<code class="descname">draw_frame</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.PaddedBox.draw_frame" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_extent_offsets</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.PaddedBox.get_extent_offsets" title="Permalink to this definition">¶</a></dt>

<dd>update offset of childrens and return the extents of the box

</dd></dl>

<code class="descname">update_frame</code>(bbox, fontsize=None)<a class="headerlink" href="#matplotlib.offsetbox.PaddedBox.update_frame" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.offsetbox.</code><code class="descname">TextArea</code>(s, textprops=None, multilinebaseline=None, minimumdescent=True)<a class="headerlink" href="#matplotlib.offsetbox.TextArea" title="Permalink to this definition">¶</a></dt>

The TextArea is contains a single Text instance. The text is

placed at (0,0) with baseline+left alignment. The width and height

of the TextArea instance is the width and height of the its child

text.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">s : str

<div>a string to be displayed.

</div></blockquote>

textprops : <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal">FontProperties</code></a>, optional

multilinebaseline : bool, optional

<div>If <code class="xref py py-obj docutils literal">True</code>, baseline for multiline text is adjusted so that

it is (approximatedly) center-aligned with singleline

text.

</div></blockquote>

minimumdescent : bool, optional

<div>If <code class="xref py py-obj docutils literal">True</code>, the box has a minimum descent of “p”.

</div></blockquote>

</td>

</tr>

</tbody>

</table>

<code class="descname">draw</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.TextArea.draw" title="Permalink to this definition">¶</a></dt>

<dd>Draw the children

</dd></dl>

<code class="descname">get_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_extent" title="Permalink to this definition">¶</a></dt>

<code class="descname">get_minimumdescent</code>()<a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_minimumdescent" title="Permalink to this definition">¶</a></dt>

<dd>get minimumdescent.

</dd></dl>

<code class="descname">get_multilinebaseline</code>()<a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_multilinebaseline" title="Permalink to this definition">¶</a></dt>

<dd>get multilinebaseline .

</dd></dl>

<code class="descname">get_offset</code>()<a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_offset" title="Permalink to this definition">¶</a></dt>

<dd>return offset of the container.

</dd></dl>

<dd>Returns the string representation of this area’s text

</dd></dl>

<code class="descname">get_window_extent</code>(renderer)<a class="headerlink" href="#matplotlib.offsetbox.TextArea.get_window_extent" title="Permalink to this definition">¶</a></dt>

<dd>get the bounding box in display space.

</dd></dl>

<code class="descname">set_minimumdescent</code>(t)<a class="headerlink" href="#matplotlib.offsetbox.TextArea.set_minimumdescent" title="Permalink to this definition">¶</a></dt>

<dd>Set minimumdescent .

If True, extent of the single line text is adjusted so that

it has minimum descent of “p”

</dd></dl>

<code class="descname">set_multilinebaseline</code>(t)<a class="headerlink" href="#matplotlib.offsetbox.TextArea.set_multilinebaseline" title="Permalink to this definition">¶</a></dt>

<dd>Set multilinebaseline .

If True, baseline for multiline text is

adjusted so that it is (approximatedly) center-aligned with

singleline text.

</dd></dl>

<code class="descname">set_offset</code>(xy)<a class="headerlink" href="#matplotlib.offsetbox.TextArea.set_offset" title="Permalink to this definition">¶</a></dt>

<dd>set offset of the container.

Accept : tuple of x,y coordinates in display units.

</dd></dl>

<dd>Set the text of this area as a string.

</dd></dl>

View remainder of file in raw view

matplotlib.github.com/2.0.0/api/offsetbox_api.html at plausible · matplotlib/matplotlib.github.com · GitHub

Navigation Menu

Expand file tree

Breadcrumbs

offsetbox_api.html

Latest commit

History

Breadcrumbs

offsetbox_api.html

File metadata and controls

Footer

Footer navigation