matplotlib.github.com/3.3.0/_modules/matplotlib/table.html at main · matplotlib/matplotlib.github.com

Repository navigation

History

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

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

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

<head>

<title>matplotlib.table — Matplotlib 3.3.0 documentation</title>

title="Search within Matplotlib 3.3.0 documentation"

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

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.0). 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.0</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>

</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.table</h1><div class="highlight"><pre>

# Original code by:

# John Gill <jng@europe.renre.com>

#

# Subsequent changes:

# The Matplotlib development team

# Copyright The Matplotlib development team

"""

Tables drawing.

Use the factory function `~matplotlib.table.table` to create a ready-made

table from texts. If you need more control, use the `.Table` class and its

methods.

The table consists of a grid of cells, which are indexed by (row, column).

The cell (0, 0) is positioned at the top left.

Thanks to John Gill for providing the class and table.

"""

from . import artist, cbook, docstring

from .artist import Artist, allow_rasterization

from .patches import Rectangle

from .text import Text

from .transforms import Bbox

from .path import Path

<div class="viewcode-block" id="Cell"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell">[docs]</a>class Cell(Rectangle):

"""

A cell is a `.Rectangle` with some associated `.Text`.

As a user, you'll most likely not creates cells yourself. Instead, you

should use either the `~matplotlib.table.table` factory function or

`.Table.add_cell`.

"""

PAD = 0.1

"""Padding between text and rectangle."""

_edges = 'BRTL'

_edge_aliases = {'open': '',

'closed': _edges, # default

'horizontal': 'BT',

'vertical': 'RL'

}

def __init__(self, xy, width, height,

edgecolor='k', facecolor='w',

fill=True,

text='',

loc=None,

fontproperties=None,

*,

visible_edges='closed',

):

"""

Parameters

----------

xy : 2-tuple

The position of the bottom left corner of the cell.

width : float

The cell width.

height : float

The cell height.

edgecolor : color

The color of the cell border.

facecolor : color

The cell facecolor.

fill : bool

Whether the cell background is filled.

text : str

The cell text.

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

The alignment of the text within the cell.

fontproperties : dict

A dict defining the font properties of the text. Supported keys and

values are the keyword arguments accepted by `.FontProperties`.

visible_edges : str, default: 'closed'

The cell edges to be drawn with a line: a substring of 'BRTL'

(bottom, right, top, left), or one of 'open' (no edges drawn),

'closed' (all edges drawn), 'horizontal' (bottom and top),

'vertical' (right and left).

"""

# Call base

Rectangle.__init__(self, xy, width=width, height=height, fill=fill,

edgecolor=edgecolor, facecolor=facecolor)

self.set_clip_on(False)

self.visible_edges = visible_edges

# Create text object

if loc is None:

loc = 'right'

self._loc = loc

self._text = Text(x=xy[0], y=xy[1], clip_on=False,

text=text, fontproperties=fontproperties,

horizontalalignment=loc, verticalalignment='center')

<div class="viewcode-block" id="Cell.set_transform"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.set_transform">[docs]</a> def set_transform(self, trans):

Rectangle.set_transform(self, trans)

# the text does not get the transform!

self.stale = True</div>

<div class="viewcode-block" id="Cell.set_figure"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.set_figure">[docs]</a> def set_figure(self, fig):

Rectangle.set_figure(self, fig)

self._text.set_figure(fig)</div>

<div class="viewcode-block" id="Cell.get_text"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.get_text">[docs]</a> def get_text(self):

"""Return the cell `.Text` instance."""

return self._text</div>

<div class="viewcode-block" id="Cell.set_fontsize"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.set_fontsize">[docs]</a> def set_fontsize(self, size):

"""Set the text fontsize."""

self._text.set_fontsize(size)

self.stale = True</div>

<div class="viewcode-block" id="Cell.get_fontsize"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.get_fontsize">[docs]</a> def get_fontsize(self):

"""Return the cell fontsize."""

return self._text.get_fontsize()</div>

<div class="viewcode-block" id="Cell.auto_set_font_size"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.auto_set_font_size">[docs]</a> def auto_set_font_size(self, renderer):

"""Shrink font size until the text fits into the cell width."""

fontsize = self.get_fontsize()

required = self.get_required_width(renderer)

while fontsize > 1 and required > self.get_width():

fontsize -= 1

self.set_fontsize(fontsize)

return fontsize</div>

<div class="viewcode-block" id="Cell.draw"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.draw">[docs]</a> @allow_rasterization

def draw(self, renderer):

if not self.get_visible():

return

# draw the rectangle

Rectangle.draw(self, renderer)

# position the text

self._set_text_position(renderer)

self._text.draw(renderer)

self.stale = False</div>

def _set_text_position(self, renderer):

"""Set text up so it is drawn in the right place."""

bbox = self.get_window_extent(renderer)

# center vertically

y = bbox.y0 + bbox.height / 2

# position horizontally

loc = self._text.get_horizontalalignment()

if loc == 'center':

elif loc == 'left':

x = bbox.x0 + bbox.width * self.PAD

else: # right.

x = bbox.x0 + bbox.width * (1 - self.PAD)

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

<div class="viewcode-block" id="Cell.get_text_bounds"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.get_text_bounds">[docs]</a> def get_text_bounds(self, renderer):

"""

Return the text bounds as *(x, y, width, height)* in table coordinates.

"""

return (self._text.get_window_extent(renderer)

.transformed(self.get_data_transform().inverted())

.bounds)</div>

<div class="viewcode-block" id="Cell.get_required_width"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.get_required_width">[docs]</a> def get_required_width(self, renderer):

"""Return the minimal required width for the cell."""

l, b, w, h = self.get_text_bounds(renderer)

return w * (1.0 + (2.0 * self.PAD))</div>

<div class="viewcode-block" id="Cell.set_text_props"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.set_text_props">[docs]</a> @docstring.dedent_interpd

def set_text_props(self, **kwargs):

"""

Update the text properties.

Valid keyword arguments are:

%(Text)s

"""

self._text.update(kwargs)

self.stale = True</div>

@property

def visible_edges(self):

"""

The cell edges to be drawn with a line.

Reading this property returns a substring of 'BRTL' (bottom, right,

top, left').

When setting this property, you can use a substring of 'BRTL' or one

of {'open', 'closed', 'horizontal', 'vertical'}.

"""

return self._visible_edges

@visible_edges.setter

def visible_edges(self, value):

if value is None:

self._visible_edges = self._edges

elif value in self._edge_aliases:

self._visible_edges = self._edge_aliases[value]

else:

if any(edge not in self._edges for edge in value):

raise ValueError('Invalid edge param {}, must only be one of '

'{} or string of {}'.format(

value,

", ".join(self._edge_aliases),

self._visible_edges = value

self.stale = True

<div class="viewcode-block" id="Cell.get_path"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Cell.get_path">[docs]</a> def get_path(self):

"""Return a `.Path` for the `.visible_edges`."""

codes = [Path.MOVETO]

codes.extend(

Path.LINETO if edge in self._visible_edges else Path.MOVETO

for edge in self._edges)

if Path.MOVETO not in codes[1:]: # All sides are visible

codes[-1] = Path.CLOSEPOLY

return Path(

[[0.0, 0.0], [1.0, 0.0], [1.0, 1.0], [0.0, 1.0], [0.0, 0.0]],

codes,

readonly=True

)</div></div>

CustomCell = Cell # Backcompat. alias.

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

"""

A table of cells.

The table consists of a grid of cells, which are indexed by (row, column).

For a simple table, you'll have a full grid of cells with indices from

(0, 0) to (num_rows-1, num_cols-1), in which the cell (0, 0) is positioned

at the top left. However, you can also add cells with negative indices.

You don't have to add a cell to every grid position, so you can create

tables that have holes.

*Note*: You'll usually not create an empty table from scratch. Instead use

`~matplotlib.table.table` to create a table from data.

"""

codes = {'best': 0,

'upper right': 1, # default

'upper left': 2,

'lower left': 3,

'lower right': 4,

'center left': 5,

'center right': 6,

'lower center': 7,

'upper center': 8,

'center': 9,

'top right': 10,

'top left': 11,

'bottom left': 12,

'bottom right': 13,

'right': 14,

'left': 15,

'top': 16,

'bottom': 17,

}

"""Possible values where to place the table relative to the Axes."""

FONTSIZE = 10

AXESPAD = 0.02

"""The border between the Axes and the table edge in Axes units."""

def __init__(self, ax, loc=None, bbox=None, **kwargs):

"""

Parameters

----------

ax : `matplotlib.axes.Axes`

The `~.axes.Axes` to plot the table into.

loc : str

The position of the cell with respect to *ax*. This must be one of

the `~.Table.codes`.

bbox : `.Bbox` or None

A bounding box to draw the table into. If this is not *None*, this

overrides *loc*.

Other Parameters

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

**kwargs

`.Artist` properties.

"""

Artist.__init__(self)

if isinstance(loc, str):

if loc not in self.codes:

raise ValueError(

"Unrecognized location {!r}. Valid locations are\n\t{}"

.format(loc, '\n\t'.join(self.codes)))

loc = self.codes[loc]

self.set_figure(ax.figure)

self._axes = ax

self._loc = loc

self._bbox = bbox

# use axes coords

ax._unstale_viewLim()

self.set_transform(ax.transAxes)

self._cells = {}

self._edges = None

self._autoColumns = []

self._autoFontsize = True

self.update(kwargs)

self.set_clip_on(False)

<div class="viewcode-block" id="Table.add_cell"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Table.add_cell">[docs]</a> def add_cell(self, row, col, *args, **kwargs):

"""

Create a cell and add it to the table.

Parameters

----------

row : int

Row index.

col : int

Column index.

*args, **kwargs

All other parameters are passed on to `Cell`.

Returns

-------

`.Cell`

The created cell.

"""

xy = (0, 0)

cell = Cell(xy, visible_edges=self.edges, *args, **kwargs)

self[row, col] = cell

return cell</div>

def __setitem__(self, position, cell):

"""

Set a custom cell in a given position.

"""

cbook._check_isinstance(Cell, cell=cell)

try:

row, col = position[0], position[1]

except Exception as err:

raise KeyError('Only tuples length 2 are accepted as '

'coordinates') from err

cell.set_figure(self.figure)

cell.set_transform(self.get_transform())

cell.set_clip_on(False)

self._cells[row, col] = cell

self.stale = True

def __getitem__(self, position):

"""Retrieve a custom cell from a given position."""

return self._cells[position]

@property

def edges(self):

"""

The default value of `~.Cell.visible_edges` for newly added

cells using `.add_cell`.

Notes

-----

This setting does currently only affect newly created cells using

`.add_cell`.

To change existing cells, you have to set their edges explicitly::

for c in tab.get_celld().values():

c.visible_edges = 'horizontal'

"""

return self._edges

@edges.setter

def edges(self, value):

self._edges = value

self.stale = True

def _approx_text_height(self):

return (self.FONTSIZE / 72.0 * self.figure.dpi /

self._axes.bbox.height * 1.2)

<div class="viewcode-block" id="Table.draw"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Table.draw">[docs]</a> @allow_rasterization

def draw(self, renderer):

# docstring inherited

# Need a renderer to do hit tests on mouseevent; assume the last one

# will do

if renderer is None:

renderer = self.figure._cachedRenderer

if renderer is None:

raise RuntimeError('No renderer defined')

if not self.get_visible():

return

renderer.open_group('table', gid=self.get_gid())

self._update_positions(renderer)

for key in sorted(self._cells):

self._cells[key].draw(renderer)

renderer.close_group('table')

self.stale = False</div>

def _get_grid_bbox(self, renderer):

"""

Get a bbox, in axes coordinates for the cells.

Only include those in the range (0, 0) to (maxRow, maxCol).

"""

boxes = [cell.get_window_extent(renderer)

for (row, col), cell in self._cells.items()

if row >= 0 and col >= 0]

bbox = Bbox.union(boxes)

return bbox.transformed(self.get_transform().inverted())

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

# docstring inherited

inside, info = self._default_contains(mouseevent)

if inside is not None:

return inside, info

# TODO: Return index of the cell containing the cursor so that the user

# doesn't have to bind to each one individually.

if renderer is not None:

return bbox.contains(mouseevent.x, mouseevent.y), {}

else:

return False, {}</div>

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

"""Return the Artists contained by the table."""

return list(self._cells.values())</div>

<div class="viewcode-block" id="Table.get_window_extent"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Table.get_window_extent">[docs]</a> def get_window_extent(self, renderer):

"""Return the bounding box of the table in window coords."""

self._update_positions(renderer)

for cell in self._cells.values()]

return Bbox.union(boxes)</div>

def _do_cell_alignment(self):

"""

Calculate row heights and column widths; position cells accordingly.

"""

# Calculate row/column widths

widths = {}

heights = {}

height = heights.setdefault(row, 0.0)

heights[row] = max(height, cell.get_height())

width = widths.setdefault(col, 0.0)

widths[col] = max(width, cell.get_width())

# work out left position for each column

xpos = 0

lefts = {}

for col in sorted(widths):

lefts[col] = xpos

xpos += widths[col]

ypos = 0

bottoms = {}

for row in sorted(heights, reverse=True):

bottoms[row] = ypos

ypos += heights[row]

# set cell positions

cell.set_x(lefts[col])

cell.set_y(bottoms[row])

<div class="viewcode-block" id="Table.auto_set_column_width"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Table.auto_set_column_width">[docs]</a> def auto_set_column_width(self, col):

"""

Automatically set the widths of given columns to optimal sizes.

Parameters

----------

col : int or sequence of ints

The indices of the columns to auto-scale.

"""

# check for col possibility on iteration

try:

iter(col)

except (TypeError, AttributeError):

self._autoColumns.append(col)

else:

for cell in col:

self.stale = True</div>

def _auto_set_column_width(self, col, renderer):

"""Automatically set width for column."""

cells = [cell for key, cell in self._cells.items() if key[1] == col]

max_width = max((cell.get_required_width(renderer) for cell in cells),

default=0)

for cell in cells:

cell.set_width(max_width)

<div class="viewcode-block" id="Table.auto_set_font_size"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Table.auto_set_font_size">[docs]</a> def auto_set_font_size(self, value=True):

"""Automatically set font size."""

self._autoFontsize = value

self.stale = True</div>

def _auto_set_font_size(self, renderer):

if len(self._cells) == 0:

return

fontsize = next(iter(self._cells.values())).get_fontsize()

cells = []

for key, cell in self._cells.items():

# ignore auto-sized columns

if key[1] in self._autoColumns:

continue

size = cell.auto_set_font_size(renderer)

fontsize = min(fontsize, size)

cells.append(cell)

# now set all fontsizes equal

cell.set_fontsize(fontsize)

<div class="viewcode-block" id="Table.scale"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Table.scale">[docs]</a> def scale(self, xscale, yscale):

"""Scale column widths by *xscale* and row heights by *yscale*."""

for c in self._cells.values():

c.set_width(c.get_width() * xscale)

c.set_height(c.get_height() * yscale)</div>

<div class="viewcode-block" id="Table.set_fontsize"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Table.set_fontsize">[docs]</a> def set_fontsize(self, size):

"""

Set the font size, in points, of the cell text.

Parameters

----------

size : float

Notes

-----

As long as auto font size has not been disabled, the value will be

clipped such that the text fits horizontally into the cell.

You can disable this behavior using `.auto_set_font_size`.

>>> the_table.auto_set_font_size(False)

>>> the_table.set_fontsize(20)

However, there is no automatic scaling of the row height so that the

text may exceed the cell boundary.

"""

cell.set_fontsize(size)

self.stale = True</div>

def _offset(self, ox, oy):

"""Move all the artists by ox, oy (axes coords)."""

x, y = c.get_x(), c.get_y()

c.set_x(x + ox)

c.set_y(y + oy)

def _update_positions(self, renderer):

# called from renderer to allow more precise estimates of

# widths and heights with get_window_extent

# Do any auto width setting

for col in self._autoColumns:

self._auto_set_column_width(col, renderer)

if self._autoFontsize:

self._auto_set_font_size(renderer)

# Align all the cells

self._do_cell_alignment()

bbox = self._get_grid_bbox(renderer)

l, b, w, h = bbox.bounds

if self._bbox is not None:

# Position according to bbox

rl, rb, rw, rh = self._bbox

self.scale(rw / w, rh / h)

ox = rl - l

oy = rb - b

self._do_cell_alignment()

else:

# Position using loc

(BEST, UR, UL, LL, LR, CL, CR, LC, UC, C,

TR, TL, BL, BR, R, L, T, B) = range(len(self.codes))

# defaults for center

ox = (0.5 - w / 2) - l

oy = (0.5 - h / 2) - b

if self._loc in (UL, LL, CL): # left

ox = self.AXESPAD - l

if self._loc in (BEST, UR, LR, R, CR): # right

ox = 1 - (l + w + self.AXESPAD)

if self._loc in (BEST, UR, UL, UC): # upper

oy = 1 - (b + h + self.AXESPAD)

if self._loc in (LL, LR, LC): # lower

oy = self.AXESPAD - b

if self._loc in (LC, UC, C): # center x

if self._loc in (CL, CR, C): # center y

if self._loc in (TL, BL, L): # out left

ox = - (l + w)

if self._loc in (TR, BR, R): # out right

ox = 1.0 - l

if self._loc in (TR, TL, T): # out top

oy = 1.0 - b

if self._loc in (BL, BR, B): # out bottom

oy = - (b + h)

self._offset(ox, oy)

<div class="viewcode-block" id="Table.get_celld"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.Table.get_celld">[docs]</a> def get_celld(self):

r"""

Return a dict of cells in the table mapping *(row, column)* to

`.Cell`\s.

Notes

-----

You can also directly index into the Table object to access individual

cells::

cell = table[row, col]

"""

return self._cells</div></div>

docstring.interpd.update(Table=artist.kwdoc(Table))

<div class="viewcode-block" id="table"><a class="viewcode-back" href="../../api/table_api.html#matplotlib.axes.table">[docs]</a>@docstring.dedent_interpd

def table(ax,

cellText=None, cellColours=None,

cellLoc='right', colWidths=None,

rowLabels=None, rowColours=None, rowLoc='left',

colLabels=None, colColours=None, colLoc='center',

loc='bottom', bbox=None, edges='closed',

**kwargs):

"""

Add a table to an `~.axes.Axes`.

At least one of *cellText* or *cellColours* must be specified. These

parameters must be 2D lists, in which the outer lists define the rows and

the inner list define the column values per row. Each row must have the

same number of elements.

The table can optionally have row and column headers, which are configured

using *rowLabels*, *rowColours*, *rowLoc* and *colLabels*, *colColours*,

*colLoc* respectively.

For finer grained control over tables, use the `.Table` class and add it to

the axes with `.Axes.add_table`.

Parameters

----------

cellText : 2D list of str, optional

The texts to place into the table cells.

*Note*: Line breaks in the strings are currently not accounted for and

will result in the text exceeding the cell boundaries.

cellColours : 2D list of colors, optional

The background colors of the cells.

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

The alignment of the text within the cells.

colWidths : list of float, optional

The column widths in units of the axes. If not given, all columns will

have a width of *1 / ncols*.

rowLabels : list of str, optional

The text of the row header cells.

rowColours : list of colors, optional

The colors of the row header cells.

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

The text alignment of the row header cells.

colLabels : list of str, optional

The text of the column header cells.

colColours : list of colors, optional

The colors of the column header cells.

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

The text alignment of the column header cells.

loc : str, optional

The position of the cell with respect to *ax*. This must be one of

the `~.Table.codes`.

bbox : `.Bbox`, optional

A bounding box to draw the table into. If this is not *None*, this

overrides *loc*.

edges : substring of 'BRTL' or {'open', 'closed', 'horizontal', 'vertical'}

The cell edges to be drawn with a line. See also

`~.Cell.visible_edges`.

Returns

-------

`~matplotlib.table.Table`

The created table.

Other Parameters

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

**kwargs

`.Table` properties.

%(Table)s

"""

if cellColours is None and cellText is None:

raise ValueError('At least one argument from "cellColours" or '

'"cellText" must be provided to create a table.')

# Check we have some cellText

if cellText is None:

# assume just colours are needed

rows = len(cellColours)

cols = len(cellColours[0])

cellText = [[''] * cols] * rows

rows = len(cellText)

cols = len(cellText[0])

for row in cellText:

if len(row) != cols:

raise ValueError("Each row in 'cellText' must have {} columns"

.format(cols))

if cellColours is not None:

if len(cellColours) != rows:

raise ValueError("'cellColours' must have {} rows".format(rows))

for row in cellColours:

raise ValueError("Each row in 'cellColours' must have {} "

"columns".format(cols))

else:

cellColours = ['w' * cols] * rows

# Set colwidths if not given

if colWidths is None:

colWidths = [1.0 / cols] * cols

# Fill in missing information for column

# and row labels

rowLabelWidth = 0

if rowLabels is None:

if rowColours is not None:

rowLabels = [''] * rows

rowLabelWidth = colWidths[0]

elif rowColours is None:

rowColours = 'w' * rows

if rowLabels is not None:

if len(rowLabels) != rows:

raise ValueError("'rowLabels' must be of length {0}".format(rows))

# If we have column labels, need to shift

# the text and colour arrays down 1 row

offset = 1

if colLabels is None:

if colColours is not None:

colLabels = [''] * cols

else:

offset = 0

elif colColours is None:

colColours = 'w' * cols

# Set up cell colours if not given

if cellColours is None:

# Now create the table

table = Table(ax, loc, bbox, **kwargs)

table.edges = edges

height = table._approx_text_height()

# Add the cells

for row in range(rows):

for col in range(cols):

table.add_cell(row + offset, col,

width=colWidths[col], height=height,

text=cellText[row][col],

facecolor=cellColours[row][col],

loc=cellLoc)

# Do column labels

if colLabels is not None:

for col in range(cols):

table.add_cell(0, col,

text=colLabels[col], facecolor=colColours[col],

loc=colLoc)

# Do row labels

if rowLabels is not None:

for row in range(rows):

width=rowLabelWidth or 1e-15, height=height,

text=rowLabels[row], facecolor=rowColours[row],

loc=rowLoc)

if rowLabelWidth == 0:

table.auto_set_column_width(-1)

ax.add_table(table)

return table</div>

</pre></div>

</div>

</div>

Last updated on Jul 17, 2020.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.

Doc version v3.3.0-3-g8994f1b60.

</div>

</footer>

</body>

</html>

FilesExpand file tree

table.html

Latest commit

History

table.html

File metadata and controls