matplotlib.github.com/3.2.1/_modules/matplotlib/text.html at main · matplotlib/matplotlib.github.com

History

2542 lines (2101 loc) · 296 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

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

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

<head>

<title>matplotlib.text — Matplotlib 3.2.1 documentation</title>

title="Search within Matplotlib 3.2.1 documentation"

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

</head><body>

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

John Hunter Excellence in Plotting Contest 2020

<a href="https://jhepc.github.io/about.html"> submissions are open!

</a>

Entries are due June 1, 2020.

</div>

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

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

</div>

<ul>

<li><a href="../../users/installing.html">Installation</a></li>

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

<li><a href="../../gallery/index.html">Examples</a></li>

<li><a href="../../tutorials/index.html">Tutorials</a></li>

<li><a href="../../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

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

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

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

>modules</a> |</li>

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

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

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

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

"""

Classes for including text in a figure.

"""

import contextlib

import logging

import math

import weakref

import numpy as np

from . import artist, cbook, docstring, rcParams

from .artist import Artist

from .font_manager import FontProperties

from .lines import Line2D

from .patches import FancyArrowPatch, FancyBboxPatch, Rectangle

from .textpath import TextPath # Unused, but imported by others.

from .transforms import (

Affine2D, Bbox, BboxBase, BboxTransformTo, IdentityTransform, Transform)

_log = logging.getLogger(__name__)

@contextlib.contextmanager

def _wrap_text(textobj):

"""Temporarily inserts newlines to the text if the wrap option is enabled.

"""

if textobj.get_wrap():

old_text = textobj.get_text()

try:

textobj.set_text(textobj._get_wrapped_text())

yield textobj

finally:

textobj.set_text(old_text)

else:

yield textobj

# Extracted from Text's method to serve as a function

<div class="viewcode-block" id="get_rotation"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.get_rotation">[docs]</a>def get_rotation(rotation):

"""

Return the text angle as float between 0 and 360 degrees.

*rotation* may be 'horizontal', 'vertical', or a numeric value in degrees.

"""

try:

return float(rotation) % 360

except (ValueError, TypeError):

if cbook._str_equal(rotation, 'horizontal') or rotation is None:

return 0.

elif cbook._str_equal(rotation, 'vertical'):

return 90.

else:

raise ValueError("rotation is {!r}; expected either 'horizontal', "

"'vertical', numeric value, or None"

.format(rotation))</div>

def _get_textbox(text, renderer):

"""

Calculate the bounding box of the text. Unlike

:meth:`matplotlib.text.Text.get_extents` method, The bbox size of

the text before the rotation is calculated.

"""

# TODO : This function may move into the Text class as a method. As a

# matter of fact, The information from the _get_textbox function

# should be available during the Text._get_layout() call, which is

# called within the _get_textbox. So, it would better to move this

# function as a method with some refactoring of _get_layout method.

projected_xs = []

projected_ys = []

theta = np.deg2rad(text.get_rotation())

tr = Affine2D().rotate(-theta)

_, parts, d = text._get_layout(renderer)

for t, wh, x, y in parts:

w, h = wh

xt1, yt1 = tr.transform((x, y))

yt1 -= d

xt2, yt2 = xt1 + w, yt1 + h

projected_xs.extend([xt1, xt2])

projected_ys.extend([yt1, yt2])

xt_box, yt_box = min(projected_xs), min(projected_ys)

w_box, h_box = max(projected_xs) - xt_box, max(projected_ys) - yt_box

x_box, y_box = Affine2D().rotate(theta).transform((xt_box, yt_box))

return x_box, y_box, w_box, h_box

<div class="viewcode-block" id="Text"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text">[docs]</a>@cbook._define_aliases({

"color": ["c"],

"fontfamily": ["family"],

"fontproperties": ["font_properties"],

"horizontalalignment": ["ha"],

"multialignment": ["ma"],

"fontname": ["name"],

"fontsize": ["size"],

"fontstretch": ["stretch"],

"fontstyle": ["style"],

"fontvariant": ["variant"],

"verticalalignment": ["va"],

"fontweight": ["weight"],

})

class Text(Artist):

"""Handle storing and drawing of text in window or data coordinates."""

zorder = 3

_cached = cbook.maxdict(50)

def __repr__(self):

return "Text(%s, %s, %s)" % (self._x, self._y, repr(self._text))

def __init__(self,

x=0, y=0, text='',

color=None, # defaults to rc params

verticalalignment='baseline',

horizontalalignment='left',

multialignment=None,

fontproperties=None, # defaults to FontProperties()

rotation=None,

linespacing=None,

rotation_mode=None,

usetex=None, # defaults to rcParams['text.usetex']

wrap=False,

**kwargs

):

"""

Create a `.Text` instance at *x*, *y* with string *text*.

Valid keyword arguments are:

%(Text)s

"""

Artist.__init__(self)

self._x, self._y = x, y

if color is None:

color = rcParams['text.color']

if fontproperties is None:

fontproperties = FontProperties()

elif isinstance(fontproperties, str):

fontproperties = FontProperties(fontproperties)

self._text = ''

self.set_text(text)

self.set_color(color)

self.set_usetex(usetex)

self.set_wrap(wrap)

self.set_verticalalignment(verticalalignment)

self.set_horizontalalignment(horizontalalignment)

self._multialignment = multialignment

self._rotation = rotation

self._fontproperties = fontproperties

self._bbox_patch = None # a FancyBboxPatch instance

self._renderer = None

if linespacing is None:

linespacing = 1.2 # Maybe use rcParam later.

self._linespacing = linespacing

self.set_rotation_mode(rotation_mode)

self.update(kwargs)

<div class="viewcode-block" id="Text.update"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.update">[docs]</a> def update(self, kwargs):

"""

Update properties from a dictionary.

"""

# Update bbox last, as it depends on font properties.

sentinel = object() # bbox can be None, so use another sentinel.

bbox = kwargs.pop("bbox", sentinel)

super().update(kwargs)

if bbox is not sentinel:

self.set_bbox(bbox)</div>

def __getstate__(self):

d = super().__getstate__()

# remove the cached _renderer (if it exists)

d['_renderer'] = None

return d

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

"""Test whether the mouse event occurred in the patch.

In the case of text, a hit is true anywhere in the

axis-aligned bounding-box containing the text.

Returns

-------

bool : bool

"""

inside, info = self._default_contains(mouseevent)

if inside is not None:

return inside, info

if not self.get_visible() or self._renderer is None:

return False, {}

# Explicitly use Text.get_window_extent(self) and not

# self.get_window_extent() so that Annotation.contains does not

# accidentally cover the entire annotation bounding box.

l, b, w, h = Text.get_window_extent(self).bounds

r, t = l + w, b + h

x, y = mouseevent.x, mouseevent.y

inside = (l <= x <= r and b <= y <= t)

cattr = {}

# if the text has a surrounding patch, also check containment for it,

# and merge the results with the results for the text.

if self._bbox_patch:

patch_inside, patch_cattr = self._bbox_patch.contains(mouseevent)

inside = inside or patch_inside

cattr["bbox_patch"] = patch_cattr

return inside, cattr</div>

def _get_xy_display(self):

"""

Get the (possibly unit converted) transformed x, y in display coords.

"""

x, y = self.get_unitless_position()

return self.get_transform().transform((x, y))

def _get_multialignment(self):

if self._multialignment is not None:

return self._multialignment

else:

return self._horizontalalignment

<div class="viewcode-block" id="Text.get_rotation"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_rotation">[docs]</a> def get_rotation(self):

"""Return the text angle as float in degrees."""

return get_rotation(self._rotation) # string_or_number -> number</div>

<div class="viewcode-block" id="Text.set_rotation_mode"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.set_rotation_mode">[docs]</a> def set_rotation_mode(self, m):

"""

Set text rotation mode.

Parameters

----------

m : {None, 'default', 'anchor'}

If ``None`` or ``"default"``, the text will be first rotated, then

aligned according to their horizontal and vertical alignments. If

``"anchor"``, then alignment occurs before rotation.

"""

cbook._check_in_list(["anchor", "default", None], rotation_mode=m)

self._rotation_mode = m

self.stale = True</div>

<div class="viewcode-block" id="Text.get_rotation_mode"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_rotation_mode">[docs]</a> def get_rotation_mode(self):

"""Get the text rotation mode."""

return self._rotation_mode</div>

<div class="viewcode-block" id="Text.update_from"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.update_from">[docs]</a> def update_from(self, other):

"""Copy properties from other to self."""

Artist.update_from(self, other)

self._color = other._color

self._multialignment = other._multialignment

self._verticalalignment = other._verticalalignment

self._horizontalalignment = other._horizontalalignment

self._fontproperties = other._fontproperties.copy()

self._rotation = other._rotation

self._picker = other._picker

self._linespacing = other._linespacing

self.stale = True</div>

def _get_layout(self, renderer):

"""

return the extent (bbox) of the text together with

multiple-alignment information. Note that it returns an extent

of a rotated text when necessary.

"""

key = self.get_prop_tup(renderer=renderer)

if key in self._cached:

return self._cached[key]

thisx, thisy = 0.0, 0.0

lines = self.get_text().split("\n") # Ensures lines is not empty.

ws = []

hs = []

xs = []

ys = []

# Full vertical extent of font, including ascenders and descenders:

_, lp_h, lp_d = renderer.get_text_width_height_descent(

"lp", self._fontproperties,

ismath="TeX" if self.get_usetex() else False)

min_dy = (lp_h - lp_d) * self._linespacing

for i, line in enumerate(lines):

clean_line, ismath = self._preprocess_math(line)

if clean_line:

w, h, d = renderer.get_text_width_height_descent(

clean_line, self._fontproperties, ismath=ismath)

else:

w = h = d = 0

# For multiline text, increase the line spacing when the text

# net-height (excluding baseline) is larger than that of a "l"

# (e.g., use of superscripts), which seems what TeX does.

h = max(h, lp_h)

d = max(d, lp_d)

ws.append(w)

hs.append(h)

# Metrics of the last line that are needed later:

baseline = (h - d) - thisy

if i == 0:

# position at baseline

thisy = -(h - d)

else:

# put baseline a good distance from bottom of previous line

thisy -= max(min_dy, (h - d) * self._linespacing)

xs.append(thisx) # == 0.

ys.append(thisy)

thisy -= d

# Metrics of the last line that are needed later:

descent = d

# Bounding box definition:

width = max(ws)

xmin = 0

xmax = width

ymax = 0

ymin = ys[-1] - descent # baseline of last line minus its descent

height = ymax - ymin

# get the rotation matrix

M = Affine2D().rotate_deg(self.get_rotation())

# now offset the individual text lines within the box

malign = self._get_multialignment()

if malign == 'left':

offset_layout = [(x, y) for x, y in zip(xs, ys)]

elif malign == 'center':

offset_layout = [(x + width / 2 - w / 2, y)

for x, y, w in zip(xs, ys, ws)]

elif malign == 'right':

offset_layout = [(x + width - w, y)

# the corners of the unrotated bounding box

corners_horiz = np.array(

[(xmin, ymin), (xmin, ymax), (xmax, ymax), (xmax, ymin)])

# now rotate the bbox

corners_rotated = M.transform(corners_horiz)

# compute the bounds of the rotated box

xmin = corners_rotated[:, 0].min()

xmax = corners_rotated[:, 0].max()

ymin = corners_rotated[:, 1].min()

ymax = corners_rotated[:, 1].max()

width = xmax - xmin

height = ymax - ymin

# Now move the box to the target position offset the display

# bbox by alignment

halign = self._horizontalalignment

valign = self._verticalalignment

rotation_mode = self.get_rotation_mode()

if rotation_mode != "anchor":

# compute the text location in display coords and the offsets

# necessary to align the bbox with that location

if halign == 'center':

offsetx = (xmin + xmax) / 2

elif halign == 'right':

offsetx = xmax

else:

offsetx = xmin

if valign == 'center':

offsety = (ymin + ymax) / 2

elif valign == 'top':

offsety = ymax

elif valign == 'baseline':

offsety = ymin + descent

elif valign == 'center_baseline':

offsety = ymin + height - baseline / 2.0

else:

offsety = ymin

else:

xmin1, ymin1 = corners_horiz[0]

xmax1, ymax1 = corners_horiz[2]

if halign == 'center':

offsetx = (xmin1 + xmax1) / 2.0

elif halign == 'right':

offsetx = xmax1

else:

offsetx = xmin1

if valign == 'center':

offsety = (ymin1 + ymax1) / 2.0

elif valign == 'top':

offsety = ymax1

elif valign == 'baseline':

offsety = ymax1 - baseline

elif valign == 'center_baseline':

offsety = ymax1 - baseline / 2.0

else:

offsety = ymin1

offsetx, offsety = M.transform((offsetx, offsety))

xmin -= offsetx

ymin -= offsety

bbox = Bbox.from_bounds(xmin, ymin, width, height)

# now rotate the positions around the first (x, y) position

xys = M.transform(offset_layout) - (offsetx, offsety)

ret = bbox, list(zip(lines, zip(ws, hs), *xys.T)), descent

self._cached[key] = ret

return ret

<div class="viewcode-block" id="Text.set_bbox"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.set_bbox">[docs]</a> def set_bbox(self, rectprops):

"""

Draw a bounding box around self.

Parameters

----------

rectprops : dict with properties for `.patches.FancyBboxPatch`

The default boxstyle is 'square'. The mutation

scale of the `.patches.FancyBboxPatch` is set to the fontsize.

Examples

--------

::

t.set_bbox(dict(facecolor='red', alpha=0.5))

"""

if rectprops is not None:

props = rectprops.copy()

boxstyle = props.pop("boxstyle", None)

pad = props.pop("pad", None)

if boxstyle is None:

boxstyle = "square"

if pad is None:

pad = 4 # points

pad /= self.get_size() # to fraction of font size

else:

if pad is None:

pad = 0.3

# boxstyle could be a callable or a string

if isinstance(boxstyle, str) and "pad" not in boxstyle:

boxstyle += ",pad=%0.2f" % pad

bbox_transmuter = props.pop("bbox_transmuter", None)

self._bbox_patch = FancyBboxPatch(

(0., 0.),

1., 1.,

boxstyle=boxstyle,

bbox_transmuter=bbox_transmuter,

transform=IdentityTransform(),

**props)

else:

self._bbox_patch = None

self._update_clip_properties()</div>

<div class="viewcode-block" id="Text.get_bbox_patch"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_bbox_patch">[docs]</a> def get_bbox_patch(self):

"""

Return the bbox Patch, or None if the `.patches.FancyBboxPatch`

is not made.

"""

return self._bbox_patch</div>

<div class="viewcode-block" id="Text.update_bbox_position_size"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.update_bbox_position_size">[docs]</a> def update_bbox_position_size(self, renderer):

"""

Update the location and the size of the bbox.

This method should be used when the position and size of the bbox needs

to be updated before actually drawing the bbox.

"""

if self._bbox_patch:

trans = self.get_transform()

# don't use self.get_unitless_position here, which refers to text

# position in Text, and dash position in TextWithDash:

posx = float(self.convert_xunits(self._x))

posy = float(self.convert_yunits(self._y))

posx, posy = trans.transform((posx, posy))

x_box, y_box, w_box, h_box = _get_textbox(self, renderer)

self._bbox_patch.set_bounds(0., 0., w_box, h_box)

theta = np.deg2rad(self.get_rotation())

tr = tr.translate(posx + x_box, posy + y_box)

self._bbox_patch.set_transform(tr)

fontsize_in_pixel = renderer.points_to_pixels(self.get_size())

self._bbox_patch.set_mutation_scale(fontsize_in_pixel)</div>

def _draw_bbox(self, renderer, posx, posy):

"""

Update the location and size of the bbox (`.patches.FancyBboxPatch`),

and draw.

"""

theta = np.deg2rad(self.get_rotation())

self._bbox_patch.draw(renderer)

def _update_clip_properties(self):

clipprops = dict(clip_box=self.clipbox,

clip_path=self._clippath,

clip_on=self._clipon)

if self._bbox_patch:

self._bbox_patch.update(clipprops)

<div class="viewcode-block" id="Text.set_clip_box"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.set_clip_box">[docs]</a> def set_clip_box(self, clipbox):

# docstring inherited.

super().set_clip_box(clipbox)

self._update_clip_properties()</div>

<div class="viewcode-block" id="Text.set_clip_path"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.set_clip_path">[docs]</a> def set_clip_path(self, path, transform=None):

# docstring inherited.

super().set_clip_path(path, transform)

self._update_clip_properties()</div>

<div class="viewcode-block" id="Text.set_clip_on"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.set_clip_on">[docs]</a> def set_clip_on(self, b):

# docstring inherited.

super().set_clip_on(b)

self._update_clip_properties()</div>

<div class="viewcode-block" id="Text.get_wrap"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_wrap">[docs]</a> def get_wrap(self):

"""Return the wrapping state for the text."""

return self._wrap</div>

<div class="viewcode-block" id="Text.set_wrap"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.set_wrap">[docs]</a> def set_wrap(self, wrap):

"""Set the wrapping state for the text.

Parameters

----------

wrap : bool

"""

self._wrap = wrap</div>

def _get_wrap_line_width(self):

"""

Return the maximum line width for wrapping text based on the current

orientation.

"""

x0, y0 = self.get_transform().transform(self.get_position())

figure_box = self.get_figure().get_window_extent()

# Calculate available width based on text alignment

alignment = self.get_horizontalalignment()

self.set_rotation_mode('anchor')

rotation = self.get_rotation()

left = self._get_dist_to_box(rotation, x0, y0, figure_box)

right = self._get_dist_to_box(

(180 + rotation) % 360, x0, y0, figure_box)

if alignment == 'left':

line_width = left

elif alignment == 'right':

line_width = right

else:

line_width = 2 * min(left, right)

return line_width

def _get_dist_to_box(self, rotation, x0, y0, figure_box):

"""

Return the distance from the given points to the boundaries of a

rotated box, in pixels.

"""

if rotation > 270:

quad = rotation - 270

h1 = y0 / math.cos(math.radians(quad))

h2 = (figure_box.x1 - x0) / math.cos(math.radians(90 - quad))

elif rotation > 180:

quad = rotation - 180

h1 = x0 / math.cos(math.radians(quad))

h2 = y0 / math.cos(math.radians(90 - quad))

elif rotation > 90:

quad = rotation - 90

h1 = (figure_box.y1 - y0) / math.cos(math.radians(quad))

h2 = x0 / math.cos(math.radians(90 - quad))

else:

h1 = (figure_box.x1 - x0) / math.cos(math.radians(rotation))

h2 = (figure_box.y1 - y0) / math.cos(math.radians(90 - rotation))

return min(h1, h2)

def _get_rendered_text_width(self, text):

"""

Return the width of a given text string, in pixels.

"""

w, h, d = self._renderer.get_text_width_height_descent(

text,

self.get_fontproperties(),

False)

return math.ceil(w)

def _get_wrapped_text(self):

"""

Return a copy of the text with new lines added, so that

the text is wrapped relative to the parent figure.

"""

# Not fit to handle breaking up latex syntax correctly, so

# ignore latex for now.

if self.get_usetex():

return self.get_text()

# Build the line incrementally, for a more accurate measure of length

line_width = self._get_wrap_line_width()

wrapped_lines = []

# New lines in the user's text force a split

unwrapped_lines = self.get_text().split('\n')

# Now wrap each individual unwrapped line

for unwrapped_line in unwrapped_lines:

sub_words = unwrapped_line.split(' ')

# Remove items from sub_words as we go, so stop when empty

while len(sub_words) > 0:

if len(sub_words) == 1:

# Only one word, so just add it to the end

wrapped_lines.append(sub_words.pop(0))

continue

for i in range(2, len(sub_words) + 1):

# Get width of all words up to and including here

line = ' '.join(sub_words[:i])

current_width = self._get_rendered_text_width(line)

# If all these words are too wide, append all not including

# last word

if current_width > line_width:

wrapped_lines.append(' '.join(sub_words[:i - 1]))

sub_words = sub_words[i - 1:]

break

# Otherwise if all words fit in the width, append them all

elif i == len(sub_words):

sub_words = []

break

return '\n'.join(wrapped_lines)

<div class="viewcode-block" id="Text.draw"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.draw">[docs]</a> @artist.allow_rasterization

def draw(self, renderer):

"""

Draws the `.Text` object to the given *renderer*.

"""

if renderer is not None:

self._renderer = renderer

if not self.get_visible():

return

if self.get_text() == '':

return

renderer.open_group('text', self.get_gid())

with _wrap_text(self) as textobj:

bbox, info, descent = textobj._get_layout(renderer)

trans = textobj.get_transform()

# don't use textobj.get_position here, which refers to text

# position in Text, and dash position in TextWithDash:

posx = float(textobj.convert_xunits(textobj._x))

posy = float(textobj.convert_yunits(textobj._y))

if not np.isfinite(posx) or not np.isfinite(posy):

_log.warning("posx and posy should be finite values")

return

canvasw, canvash = renderer.get_canvas_width_height()

# draw the FancyBboxPatch

if textobj._bbox_patch:

textobj._draw_bbox(renderer, posx, posy)

gc = renderer.new_gc()

gc.set_foreground(textobj.get_color())

gc.set_alpha(textobj.get_alpha())

gc.set_url(textobj._url)

textobj._set_gc_clip(gc)

angle = textobj.get_rotation()

for line, wh, x, y in info:

mtext = textobj if len(info) == 1 else None

x = x + posx

y = y + posy

if renderer.flipy():

y = canvash - y

clean_line, ismath = textobj._preprocess_math(line)

if textobj.get_path_effects():

from matplotlib.patheffects import PathEffectRenderer

textrenderer = PathEffectRenderer(

textobj.get_path_effects(), renderer)

else:

textrenderer = renderer

if textobj.get_usetex():

textrenderer.draw_tex(gc, x, y, clean_line,

textobj._fontproperties, angle,

mtext=mtext)

else:

textrenderer.draw_text(gc, x, y, clean_line,

textobj._fontproperties, angle,

ismath=ismath, mtext=mtext)

gc.restore()

renderer.close_group('text')

self.stale = False</div>

<div class="viewcode-block" id="Text.get_color"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_color">[docs]</a> def get_color(self):

"Return the color of the text"

return self._color</div>

<div class="viewcode-block" id="Text.get_fontproperties"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_fontproperties">[docs]</a> def get_fontproperties(self):

"Return the `.font_manager.FontProperties` object"

return self._fontproperties</div>

<div class="viewcode-block" id="Text.get_fontfamily"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_fontfamily">[docs]</a> def get_fontfamily(self):

"""

Return the list of font families used for font lookup

See Also

--------

.font_manager.FontProperties.get_family

"""

return self._fontproperties.get_family()</div>

<div class="viewcode-block" id="Text.get_fontname"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_fontname">[docs]</a> def get_fontname(self):

"""

Return the font name as string

See Also

--------

.font_manager.FontProperties.get_name

"""

<div class="viewcode-block" id="Text.get_fontstyle"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_fontstyle">[docs]</a> def get_fontstyle(self):

"""

Return the font style as string

See Also

--------

.font_manager.FontProperties.get_style

"""

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

"""

Return the font size as integer

See Also

--------

.font_manager.FontProperties.get_size_in_points

"""

<div class="viewcode-block" id="Text.get_fontvariant"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_fontvariant">[docs]</a> def get_fontvariant(self):

"""

Return the font variant as a string

See Also

--------

.font_manager.FontProperties.get_variant

"""

<div class="viewcode-block" id="Text.get_fontweight"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_fontweight">[docs]</a> def get_fontweight(self):

"""

Get the font weight as string or number

See Also

--------

.font_manager.FontProperties.get_weight

"""

<div class="viewcode-block" id="Text.get_stretch"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_stretch">[docs]</a> def get_stretch(self):

"""

Get the font stretch as a string or number

See Also

--------

.font_manager.FontProperties.get_stretch

"""

<div class="viewcode-block" id="Text.get_horizontalalignment"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_horizontalalignment">[docs]</a> def get_horizontalalignment(self):

"""

Return the horizontal alignment as string. Will be one of

'left', 'center' or 'right'.

"""

return self._horizontalalignment</div>

<div class="viewcode-block" id="Text.get_unitless_position"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_unitless_position">[docs]</a> def get_unitless_position(self):

"Return the unitless position of the text as a tuple (*x*, *y*)"

# This will get the position with all unit information stripped away.

# This is here for convenience since it is done in several locations.

x = float(self.convert_xunits(self._x))

y = float(self.convert_yunits(self._y))

return x, y</div>

<div class="viewcode-block" id="Text.get_position"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_position">[docs]</a> def get_position(self):

"Return the position of the text as a tuple (*x*, *y*)"

# This should return the same data (possible unitized) as was

# specified with 'set_x' and 'set_y'.

return self._x, self._y</div>

<div class="viewcode-block" id="Text.get_prop_tup"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_prop_tup">[docs]</a> def get_prop_tup(self, renderer=None):

"""

Return a hashable tuple of properties.

Not intended to be human readable, but useful for backends who

want to cache derived information about text (e.g., layouts) and

need to know if the text has changed.

"""

renderer = renderer or self._renderer

return (x, y, self.get_text(), self._color,

self._verticalalignment, self._horizontalalignment,

hash(self._fontproperties),

self._rotation, self._rotation_mode,

self.figure.dpi, weakref.ref(renderer),

self._linespacing

)</div>

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

"Get the text as string"

return self._text</div>

<div class="viewcode-block" id="Text.get_verticalalignment"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_verticalalignment">[docs]</a> def get_verticalalignment(self):

"""

Return the vertical alignment as string. Will be one of

'top', 'center', 'bottom' or 'baseline'.

"""

return self._verticalalignment</div>

<div class="viewcode-block" id="Text.get_window_extent"><a class="viewcode-back" href="../../api/text_api.html#matplotlib.text.Text.get_window_extent">[docs]</a> def get_window_extent(self, renderer=None, dpi=None):

"""

Return the `.Bbox` bounding the text, in display units.

In addition to being used internally, this is useful for specifying

clickable regions in a png file on a web page.

Parameters

----------

renderer : Renderer, optional

A renderer is needed to compute the bounding box. If the artist

has already been drawn, the renderer is cached; thus, it is only

necessary to pass this argument when calling `get_window_extent`

before the first `draw`. In practice, it is usually easier to

trigger a draw first (e.g. by saving the figure).

dpi : float, optional

The dpi value for computing the bbox, defaults to

``self.figure.dpi`` (*not* the renderer dpi); should be set e.g. if

to match regions with a figure saved with a custom dpi value.

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

text.html

Latest commit

History

text.html

File metadata and controls