-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
Expand file tree
/
Copy pathtext.py
More file actions
2297 lines (1915 loc) · 81.1 KB
/
Copy pathtext.py
File metadata and controls
2297 lines (1915 loc) · 81.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
"""
Classes for including text in a figure.
"""
from collections.abc import Sequence
import functools
import itertools
import logging
import math
from numbers import Real
import weakref
import numpy as np
import matplotlib as mpl
from . import _api, artist, cbook, _docstring, colors as mcolors
from .artist import Artist
from .font_manager import FontProperties, fontManager, get_font
from .patches import FancyArrowPatch, FancyBboxPatch, Rectangle
from .textpath import TextPath, TextToPath # noqa # Logically located here
from .transforms import (
Affine2D, Bbox, BboxBase, BboxTransformTo, IdentityTransform, Transform)
_log = logging.getLogger(__name__)
@functools.lru_cache(maxsize=128)
def _rotate(theta):
"""
Return an Affine2D object that rotates by the given angle in radians.
"""
return Affine2D().rotate(theta)
def _rotate_point(angle, x, y):
"""
Rotate point (x, y) by rotation angle in degrees
"""
if angle == 0:
return (x, y)
angle_rad = math.radians(angle)
cos, sin = math.cos(angle_rad), math.sin(angle_rad)
return (cos * x - sin * y, sin * x + cos * y)
def _get_text_metrics_with_cache(renderer, text, fontprop, ismath, dpi):
"""Call ``renderer.get_text_width_height_descent``, caching the results."""
# hit the outer cache layer and get the function to compute the metrics
# for this renderer instance
get_text_metrics = _get_text_metrics_function(renderer)
# call the function to compute the metrics and return
#
# We pass a copy of the fontprop because FontProperties is both mutable and
# has a `__hash__` that depends on that mutable state. This is not ideal
# as it means the hash of an object is not stable over time which leads to
# very confusing behavior when used as keys in dictionaries or hashes.
return get_text_metrics(text, fontprop.copy(), ismath, dpi)
def _get_text_metrics_function(input_renderer, _cache=weakref.WeakKeyDictionary()):
"""
Helper function to provide a two-layered cache for font metrics
To get the rendered size of a size of string we need to know:
- what renderer we are using
- the current dpi of the renderer
- the string
- the font properties
- is it math text or not
We do this as a two-layer cache with the outer layer being tied to a
renderer instance and the inner layer handling everything else.
The outer layer is implemented as `.WeakKeyDictionary` keyed on the
renderer. As long as someone else is holding a hard ref to the renderer
we will keep the cache alive, but it will be automatically dropped when
the renderer is garbage collected.
The inner layer is provided by an lru_cache with a large maximum size (such
that we expect very few cache misses in actual use cases). As the
dpi is mutable on the renderer, we need to explicitly include it as part of
the cache key on the inner layer even though we do not directly use it (it is
used in the method call on the renderer).
This function takes a renderer and returns a function that can be used to
get the font metrics.
Parameters
----------
input_renderer : maplotlib.backend_bases.RendererBase
The renderer to set the cache up for.
_cache : dict, optional
We are using the mutable default value to attach the cache to the function.
In principle you could pass a different dict-like to this function to inject
a different cache, but please don't. This is an internal function not meant to
be reused outside of the narrow context we need it for.
There is a possible race condition here between threads, we may need to drop the
mutable default and switch to a threadlocal variable in the future.
"""
if (_text_metrics := _cache.get(input_renderer, None)) is None:
# We are going to include this in the closure we put as values in the
# cache. Closing over a hard-ref would create an unbreakable reference
# cycle.
renderer_ref = weakref.ref(input_renderer)
# define the function locally to get a new lru_cache per renderer
@functools.lru_cache(4096)
# dpi is unused, but participates in cache invalidation (via the renderer).
def _text_metrics(text, fontprop, ismath, dpi):
# this should never happen under normal use, but this is a better error to
# raise than an AttributeError on `None`
if (local_renderer := renderer_ref()) is None:
raise RuntimeError(
"Trying to get text metrics for a renderer that no longer exists. "
"This should never happen and is evidence of a bug elsewhere."
)
# do the actual method call we need and return the result
return local_renderer.get_text_width_height_descent(text, fontprop, ismath)
# stash the function for later use.
_cache[input_renderer] = _text_metrics
# return the inner function
return _text_metrics
@_docstring.interpd
@_api.define_aliases({
"color": ["c"],
"fontproperties": ["font_properties"],
"fontfamily": ["family"],
"fontname": ["name"],
"fontsize": ["size"],
"fontstretch": ["stretch"],
"fontstyle": ["style"],
"fontvariant": ["variant"],
"fontweight": ["weight"],
"horizontalalignment": ["ha"],
"verticalalignment": ["va"],
"multialignment": ["ma"],
})
class Text(Artist):
"""Handle storing and drawing of text in window or data coordinates."""
zorder = 3
_charsize_cache = dict()
def __repr__(self):
return f"Text({self._x}, {self._y}, {self._text!r})"
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,
transform_rotates_text=False,
parse_math=None, # defaults to rcParams['text.parse_math']
antialiased=None, # defaults to rcParams['text.antialiased']
**kwargs
):
"""
Create a `.Text` instance at *x*, *y* with string *text*.
The text is aligned relative to the anchor point (*x*, *y*) according
to ``horizontalalignment`` (default: 'left') and ``verticalalignment``
(default: 'baseline'). See also
:doc:`/gallery/text_labels_and_annotations/text_alignment`.
While Text accepts the 'label' keyword argument, by default it is not
added to the handles of a legend.
Valid keyword arguments are:
%(Text:kwdoc)s
"""
super().__init__()
self._x, self._y = x, y
self._text = ''
self._features = None
self.set_language(None)
self._reset_visual_defaults(
text=text,
color=color,
fontproperties=fontproperties,
usetex=usetex,
parse_math=parse_math,
wrap=wrap,
verticalalignment=verticalalignment,
horizontalalignment=horizontalalignment,
multialignment=multialignment,
rotation=rotation,
transform_rotates_text=transform_rotates_text,
linespacing=linespacing,
rotation_mode=rotation_mode,
antialiased=antialiased
)
self.update(kwargs)
def _reset_visual_defaults(
self,
text='',
color=None,
fontproperties=None,
usetex=None,
parse_math=None,
wrap=False,
verticalalignment='baseline',
horizontalalignment='left',
multialignment=None,
rotation=None,
transform_rotates_text=False,
linespacing=None,
rotation_mode=None,
antialiased=None
):
self.set_text(text)
self.set_color(mpl._val_or_rc(color, "text.color"))
self.set_fontproperties(fontproperties)
self.set_usetex(usetex)
self.set_parse_math(mpl._val_or_rc(parse_math, 'text.parse_math'))
self.set_wrap(wrap)
self.set_verticalalignment(verticalalignment)
self.set_horizontalalignment(horizontalalignment)
self._multialignment = multialignment
self.set_rotation(rotation)
self._transform_rotates_text = transform_rotates_text
self._bbox_patch = None # a FancyBboxPatch instance
self._renderer = None
if linespacing is None:
linespacing = 'normal' # Maybe use rcParam later.
self.set_linespacing(linespacing)
self.set_rotation_mode(rotation_mode)
self.set_antialiased(mpl._val_or_rc(antialiased, 'text.antialiased'))
def update(self, kwargs):
# docstring inherited
ret = []
kwargs = cbook.normalize_kwargs(kwargs, Text)
sentinel = object() # bbox can be None, so use another sentinel.
# Update fontproperties first, as it has lowest priority.
fontproperties = kwargs.pop("fontproperties", sentinel)
if fontproperties is not sentinel:
ret.append(self.set_fontproperties(fontproperties))
# Update bbox last, as it depends on font properties.
bbox = kwargs.pop("bbox", sentinel)
ret.extend(super().update(kwargs))
if bbox is not sentinel:
ret.append(self.set_bbox(bbox))
return ret
def __getstate__(self):
d = super().__getstate__()
# remove the cached _renderer (if it exists)
d['_renderer'] = None
return d
def contains(self, mouseevent):
"""
Return whether the mouse event occurred inside the axis-aligned
bounding-box of the text.
"""
if (self._different_canvas(mouseevent) or 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.
bbox = Text.get_window_extent(self)
inside = (bbox.x0 <= mouseevent.x <= bbox.x1
and bbox.y0 <= mouseevent.y <= bbox.y1)
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
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
def _char_index_at(self, x):
"""
Calculate the index closest to the coordinate x in display space.
The position of text[index] is assumed to be the sum of the widths
of all preceding characters text[:index].
This works only on single line texts.
"""
if not self._text:
return 0
text = self._text
fontproperties = str(self._fontproperties)
if fontproperties not in Text._charsize_cache:
Text._charsize_cache[fontproperties] = dict()
charsize_cache = Text._charsize_cache[fontproperties]
for char in set(text):
if char not in charsize_cache:
self.set_text(char)
bb = self.get_window_extent()
charsize_cache[char] = bb.x1 - bb.x0
self.set_text(text)
bb = self.get_window_extent()
size_accum = np.cumsum([0] + [charsize_cache[x] for x in text])
std_x = x - bb.x0
return (np.abs(size_accum - std_x)).argmin()
def get_rotation(self):
"""Return the text angle in degrees in the range [0, 360)."""
if self.get_transform_rotates_text():
return self.get_transform().transform_angles(
[self._rotation], [self.get_unitless_position()]).item(0) % 360
else:
return self._rotation
def get_transform_rotates_text(self):
"""
Return whether rotations of the transform affect the text direction.
"""
return self._transform_rotates_text
def set_rotation_mode(self, m):
"""
Set text rotation mode.
Parameters
----------
m : {None, 'default', 'anchor', 'xtick', 'ytick'}
If ``"default"``, the text will be first rotated, then aligned according
to their horizontal and vertical alignments. If ``"anchor"``, then
alignment occurs before rotation. "xtick" and "ytick" adjust the
horizontal/vertical alignment so that the text is visually pointing
towards its anchor point. This is primarily used for rotated tick
labels and positions them nicely towards their ticks. Passing
``None`` will set the rotation mode to ``"default"``.
"""
if m is None:
m = "default"
else:
_api.check_in_list(("anchor", "default", "xtick", "ytick"), rotation_mode=m)
self._rotation_mode = m
self.stale = True
def get_rotation_mode(self):
"""Return the text rotation mode."""
return self._rotation_mode
def set_antialiased(self, antialiased):
"""
Set whether to use antialiased rendering.
Parameters
----------
antialiased : bool
Notes
-----
Antialiasing will be determined by :rc:`text.antialiased`
and the parameter *antialiased* will have no effect if the text contains
math expressions.
"""
self._antialiased = antialiased
self.stale = True
def get_antialiased(self):
"""Return whether antialiased rendering is used."""
return self._antialiased
def update_from(self, other):
# docstring inherited
super().update_from(other)
self._color = other._color
self._multialignment = other._multialignment
self._verticalalignment = other._verticalalignment
self._horizontalalignment = other._horizontalalignment
self._fontproperties = other._fontproperties.copy()
self._usetex = other._usetex
self._rotation = other._rotation
self._transform_rotates_text = other._transform_rotates_text
self._picker = other._picker
self._linespacing = other._linespacing
self._antialiased = other._antialiased
self.stale = True
def _get_layout(self, renderer):
"""
Return
- the rotated, axis-aligned text bbox;
- a list of ``(line, (width, ascent, descent), xy)`` tuples for each line;
- a ``(xy, (width, height))` pair of the lower-left corner and size of the
rotated, *text-aligned* text box (i.e. describing how to draw the
text-surrounding box).
"""
thisx, thisy = 0.0, 0.0
lines = self._get_wrapped_text().split("\n") # Ensures lines is not empty.
# Reminder: The ascent (a) goes from the baseline to the top and the
# descent (d) from the baseline to the bottom; both are (typically)
# nonnegative. The height h is the sum, h = a + d.
wads = [] # (width, ascents, descents)
xs = []
ys = []
min_ascent = min_descent = line_gap = None
dpi = self.get_figure(root=True).dpi
# Determine full vertical extent of font, including ascenders and descenders:
if not self.get_usetex():
if hasattr(renderer, '_get_font_height_metrics'):
# TODO: This is a temporary internal method call (for _backend_pdf_ps to
# support AFM files) until we design a proper API for the backends.
min_ascent, min_descent, line_gap = renderer._get_font_height_metrics(
self._fontproperties)
if min_ascent is None:
font = get_font(fontManager._find_fonts_by_props(self._fontproperties))
possible = [
('OS/2', 'sTypoLineGap', 'sTypoAscender', 'sTypoDescender'),
('hhea', 'lineGap', 'ascent', 'descent')
]
for table_name, linegap_key, ascent_key, descent_key in possible:
table = font.get_sfnt_table(table_name)
if table is None:
continue
# Rescale to font size/DPI if the metrics were available.
fontsize = self._fontproperties.get_size_in_points()
units_per_em = font.get_sfnt_table('head')['unitsPerEm']
scale = 1 / units_per_em * fontsize * dpi / 72
line_gap = table[linegap_key] * scale
min_ascent = table[ascent_key] * scale
min_descent = -table[descent_key] * scale
break
if None in (min_ascent, min_descent):
# Fallback to font measurement.
_, h, min_descent = _get_text_metrics_with_cache(
renderer, "lp", self._fontproperties,
ismath="TeX" if self.get_usetex() else False,
dpi=dpi)
min_ascent = h - min_descent
line_gap = 0
# Don't increase text height too much if it's not multiple lines.
if len(lines) == 1:
line_gap = 0
for line in lines:
clean_line, ismath = self._preprocess_math(line)
if clean_line:
w, h, d = _get_text_metrics_with_cache(
renderer, clean_line, self._fontproperties,
ismath=ismath, dpi=self.get_figure(root=True).dpi)
else:
w = h = d = 0
a = h - d
if self.get_usetex() or self._linespacing == 'normal':
# To ensure good linespacing, pretend that the ascent / descent of all
# lines is at least as large as the measured sizes.
a = max(a, min_ascent) + line_gap / 2
d = max(d, min_descent) + line_gap / 2
else:
# If using a fixed line spacing, then every line's spacing will be
# determined by the font metrics of the first available font.
line_height = self._linespacing * (min_ascent + min_descent)
leading = line_height - (a + d)
a += leading / 2
d += leading / 2
# Metrics of the last line that are needed later:
baseline = a - thisy
thisy -= a
wads.append((w, a, d))
xs.append(thisx) # == 0.
ys.append(thisy)
thisy -= d
# Metrics of the last line that are needed later:
descent = d
# Bounding box definition:
ws = [w for w, a, d in wads]
width = max(ws)
xmin = 0
xmax = width
ymax = 0
ymin = ys[-1] - descent # baseline of last line minus its descent
# 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)
for x, y, w in zip(xs, ys, ws)]
# the corners of the unrotated bounding box
corners_horiz = [(xmin, ymin), (xmin, ymax), (xmax, ymax), (xmax, ymin)]
size_horiz = (xmax - xmin, ymax - ymin)
# now rotate the bbox
angle = self.get_rotation()
rotate = functools.partial(_rotate_point, angle)
corners_rotated = [rotate(x, y) for x, y in corners_horiz]
# compute the bounds of the rotated box
xs, ys = zip(*corners_rotated)
xmin, xmax = min(xs), max(xs)
ymin, ymax = min(ys), max(ys)
width_rot = xmax - xmin
height_rot = 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":
if rotation_mode == 'xtick':
halign = self._ha_for_angle(angle)
elif rotation_mode == 'ytick':
valign = self._va_for_angle(angle)
# compute the text location in display coords and the offsets
# necessary to align the bbox with that location
offsetx = (
xmin if halign == "left" else
xmax if halign == "right" else
(xmin + xmax) / 2 # halign == "center"
)
offsety = (
ymin if valign == "bottom" else
ymax if valign == "top" else
(ymin + ymax) / 2 if valign == "center" else
ymin + descent if valign == "baseline" else
ymin + height_rot - baseline / 2 # valign == "center_baseline"
)
else:
xmin1, ymin1 = corners_horiz[0]
xmax1, ymax1 = corners_horiz[2]
offsetx = (
xmin1 if halign == "left" else
xmax1 if halign == "right" else
(xmin1 + xmax1) / 2 # halign == "center"
)
offsety = (
ymin1 if valign == "bottom" else
ymax1 if valign == "top" else
(ymin1 + ymax1) / 2 if valign == "center" else
ymax1 - baseline if valign == "baseline" else
ymax1 - baseline / 2 # valign == "center_baseline"
)
offsetx, offsety = rotate(offsetx, offsety)
xmin -= offsetx
ymin -= offsety
bbox_rot = Bbox.from_bounds(xmin, ymin, width_rot, height_rot)
# now rotate the positions around the first (x, y) position
xys = [(x - offsetx, y - offsety)
for x, y in itertools.starmap(rotate, offset_layout)]
x, y = corners_rotated[0]
xy_corner = (x - offsetx, y - offsety)
return bbox_rot, list(zip(lines, wads, xys)), (xy_corner, size_horiz)
def set_bbox(self, rectprops):
"""
Draw a box behind/around the text.
This can be used to set a background and/or a frame around the text.
It's realized through a `.FancyBboxPatch` behind the text (see also
`.Text.get_bbox_patch`). The bbox patch is None by default and only
created when needed.
Parameters
----------
rectprops : dict with properties for `.FancyBboxPatch` or None
The default boxstyle is 'square'. The mutation
scale of the `.patches.FancyBboxPatch` is set to the fontsize.
Pass ``None`` to remove the bbox patch completely.
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
self._bbox_patch = FancyBboxPatch(
(0, 0), 1, 1,
boxstyle=boxstyle, transform=IdentityTransform(), **props)
else:
self._bbox_patch = None
self._update_clip_properties()
def get_bbox_patch(self):
"""
Return the bbox Patch, or None if the `.patches.FancyBboxPatch`
is not made.
For more details see `.Text.set_bbox`.
"""
return self._bbox_patch
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:
# don't use self.get_unitless_position here, which refers to text
# position in Text:
posx = float(self.convert_xunits(self._x))
posy = float(self.convert_yunits(self._y))
posx, posy = self.get_transform().transform((posx, posy))
_, _, ((x_box, y_box), (w_box, h_box)) = self._get_layout(renderer)
self._bbox_patch.set_bounds(0., 0., w_box, h_box)
self._bbox_patch.set_transform(
Affine2D()
.rotate_deg(self.get_rotation())
.translate(posx + x_box, posy + y_box))
fontsize_in_pixel = renderer.points_to_pixels(self.get_size())
self._bbox_patch.set_mutation_scale(fontsize_in_pixel)
def _update_clip_properties(self):
if self._bbox_patch:
clipprops = dict(clip_box=self.clipbox,
clip_path=self._clippath,
clip_on=self._clipon)
self._bbox_patch.update(clipprops)
def set_clip_box(self, clipbox):
# docstring inherited.
super().set_clip_box(clipbox)
self._update_clip_properties()
def set_clip_path(self, path, transform=None):
# docstring inherited.
super().set_clip_path(path, transform)
self._update_clip_properties()
def set_clip_on(self, b):
# docstring inherited.
super().set_clip_on(b)
self._update_clip_properties()
def get_wrap(self):
"""Return whether the text can be wrapped."""
return self._wrap
def set_wrap(self, wrap):
"""
Set whether the text can be wrapped.
Wrapping makes sure the text is confined to the (sub)figure box. It
does not take into account any other artists.
Parameters
----------
wrap : bool
Notes
-----
Wrapping does not work together with
``savefig(..., bbox_inches='tight')`` (which is also used internally
by ``%matplotlib inline`` in IPython/Jupyter). The 'tight' setting
rescales the canvas to accommodate all content and happens before
wrapping.
"""
self._wrap = wrap
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')
angle = self.get_rotation()
left = self._get_dist_to_box(angle, x0, y0, figure_box)
right = self._get_dist_to_box(
(180 + angle) % 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 - figure_box.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 - figure_box.x0) / math.cos(math.radians(quad))
h2 = (y0 - figure_box.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 - figure_box.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 = _get_text_metrics_with_cache(
self._renderer, text, self.get_fontproperties(),
cbook.is_math_text(text),
self.get_figure(root=True).dpi)
return math.ceil(w)
def _get_wrapped_text(self):
"""
Return a copy of the text string with new lines added so that the text
is wrapped relative to the parent figure (if `get_wrap` is True).
"""
if not self.get_wrap():
return self.get_text()
# 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):
wrapped_lines.append(' '.join(sub_words[:i]))
sub_words = []
break
return '\n'.join(wrapped_lines)
@artist.allow_rasterization
def draw(self, renderer):
# docstring inherited
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())
bbox, info, _ = self._get_layout(renderer)
trans = self.get_transform()
# don't use self.get_position here, which refers to text
# position in Text:
x, y = self._x, self._y
if np.ma.is_masked(x):
x = np.nan
if np.ma.is_masked(y):
y = np.nan
posx = float(self.convert_xunits(x))
posy = float(self.convert_yunits(y))
posx, posy = trans.transform((posx, posy))
if np.isnan(posx) or np.isnan(posy):
return # don't throw a warning here
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()
# Update the location and size of the bbox
# (`.patches.FancyBboxPatch`), and draw it.
if self._bbox_patch:
self.update_bbox_position_size(renderer)
self._bbox_patch.draw(renderer)
gc = renderer.new_gc()
gc.set_foreground(mcolors.to_rgba(self.get_color()), isRGBA=True)
gc.set_alpha(self.get_alpha())
gc.set_url(self._url)
gc.set_antialiased(self._antialiased)
gc.set_snap(self.get_snap())
self._set_gc_clip(gc)
angle = self.get_rotation()
for line, wad, (x, y) in info:
mtext = self if len(info) == 1 else None
x = x + posx
y = y + posy
if renderer.flipy():
y = canvash - y
clean_line, ismath = self._preprocess_math(line)
if self.get_path_effects():
from matplotlib.patheffects import PathEffectRenderer
textrenderer = PathEffectRenderer(self.get_path_effects(), renderer)
else:
textrenderer = renderer
if self.get_usetex():
textrenderer.draw_tex(gc, x, y, clean_line,
self._fontproperties, angle,
mtext=mtext)
else:
textrenderer.draw_text(gc, x, y, clean_line,
self._fontproperties, angle,
ismath=ismath, mtext=mtext)
gc.restore()
renderer.close_group('text')
self.stale = False
def get_color(self):
"""Return the color of the text."""
return self._color
def get_fontproperties(self):
"""Return the `.font_manager.FontProperties`."""
return self._fontproperties
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()
def get_fontfeatures(self):
"""
Return a tuple of font feature tags to enable.
"""
return self._features
def get_fontname(self):
"""
Return the font name as a string.
See Also
--------
.font_manager.FontProperties.get_name
"""
return self._fontproperties.get_name()
def get_fontstyle(self):
"""
Return the font style as a string.
See Also
--------
.font_manager.FontProperties.get_style
"""
return self._fontproperties.get_style()
def get_fontsize(self):
"""
Return the font size as an integer.
See Also
--------
.font_manager.FontProperties.get_size_in_points
"""
return self._fontproperties.get_size_in_points()
def get_fontvariant(self):
"""
Return the font variant as a string.
See Also
--------
.font_manager.FontProperties.get_variant
"""
return self._fontproperties.get_variant()
def get_fontweight(self):
"""
Return the font weight as a string or a number.
See Also
--------
.font_manager.FontProperties.get_weight
"""
return self._fontproperties.get_weight()
def get_stretch(self):
"""
Return the font stretch as a string or a number.
See Also
--------
.font_manager.FontProperties.get_stretch
"""
return self._fontproperties.get_stretch()