From 50ec1c6bb14f3b79928040dcee42b226b5597f9d Mon Sep 17 00:00:00 2001
From: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Date: Thu, 27 Aug 2020 20:59:13 -0400
Subject: [PATCH] Support horizontalalignment in TextArea/AnchoredText.

Fixes #18363.
---
 lib/matplotlib/offsetbox.py                   |  46 ++++++++++--------
 .../test_offsetbox/anchoredtext_align.png     | Bin 0 -> 6729 bytes
 lib/matplotlib/tests/test_offsetbox.py        |  19 +++++++-
 3 files changed, 43 insertions(+), 22 deletions(-)
 create mode 100644 lib/matplotlib/tests/baseline_images/test_offsetbox/anchoredtext_align.png

diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
index b721a5a20134..a788d34040bb 100644
--- a/lib/matplotlib/offsetbox.py
+++ b/lib/matplotlib/offsetbox.py
@@ -769,10 +769,11 @@ def draw(self, renderer):
 
 class TextArea(OffsetBox):
     """
-    The TextArea is contains a single Text instance. The text is
-    placed at (0, 0) with baseline+left alignment. The width and height
-    of the TextArea instance is the width and height of the its child
-    text.
+    The TextArea is a container artist for a single Text instance.
+
+    The text is placed at (0, 0) with baseline+left alignment, by default. The
+    width and height of the TextArea instance is the width and height of its
+    child text.
     """
     def __init__(self, s,
                  textprops=None,
@@ -876,37 +877,43 @@ def get_offset(self):
     def get_window_extent(self, renderer):
         """Return the bounding box in display space."""
         w, h, xd, yd = self.get_extent(renderer)
-        ox, oy = self.get_offset()  # w, h, xd, yd)
+        ox, oy = self.get_offset()
         return mtransforms.Bbox.from_bounds(ox - xd, oy - yd, w, h)
 
     def get_extent(self, renderer):
         _, h_, d_ = renderer.get_text_width_height_descent(
             "lp", self._text._fontproperties, ismath=False)
 
-        bbox, info, d = self._text._get_layout(renderer)
+        bbox, info, yd = self._text._get_layout(renderer)
         w, h = bbox.width, bbox.height
 
         self._baseline_transform.clear()
 
         if len(info) > 1 and self._multilinebaseline:
-            d_new = 0.5 * h - 0.5 * (h_ - d_)
-            self._baseline_transform.translate(0, d - d_new)
-            d = d_new
+            yd_new = 0.5 * h - 0.5 * (h_ - d_)
+            self._baseline_transform.translate(0, yd - yd_new)
+            yd = yd_new
 
         else:  # single line
 
-            h_d = max(h_ - d_, h - d)
+            h_d = max(h_ - d_, h - yd)
 
             if self.get_minimumdescent():
-                ## to have a minimum descent, #i.e., "l" and "p" have same
-                ## descents.
-                d = max(d, d_)
-            #else:
-            #    d = d
+                # To have a minimum descent, i.e., "l" and "p" have same
+                # descents.
+                yd = max(yd, d_)
 
-            h = h_d + d
+            h = h_d + yd
 
-        return w, h, 0., d
+        ha = self._text.get_horizontalalignment()
+        if ha == 'left':
+            xd = 0
+        elif ha == 'center':
+            xd = w / 2
+        elif ha == 'right':
+            xd = w
+
+        return w, h, xd, yd
 
     def draw(self, renderer):
         # docstring inherited
@@ -1288,11 +1295,10 @@ def __init__(self, s, loc, pad=0.4, borderpad=0.5, prop=None, **kwargs):
 
         if prop is None:
             prop = {}
-        badkwargs = {'ha', 'horizontalalignment', 'va', 'verticalalignment'}
+        badkwargs = {'va', 'verticalalignment'}
         if badkwargs & set(prop):
             raise ValueError(
-                "Mixing horizontalalignment or verticalalignment with "
-                "AnchoredText is not supported.")
+                'Mixing verticalalignment with AnchoredText is not supported.')
 
         self.txt = TextArea(s, textprops=prop, minimumdescent=False)
         fp = self.txt._text.get_fontproperties()
diff --git a/lib/matplotlib/tests/baseline_images/test_offsetbox/anchoredtext_align.png b/lib/matplotlib/tests/baseline_images/test_offsetbox/anchoredtext_align.png
new file mode 100644
index 0000000000000000000000000000000000000000..42a80e17b068a1476f2f5f9a0942b53f18649ab0
GIT binary patch
literal 6729
zcmeHMXIxX~8b65DTBS%uhRh4C1B4JkHbe@6sug4?hzJTuK$d|pWP7m?8KKo8C`uGm
zKxD}XJ17KHmdFSah9qnV5FrT!lHB*y_I~JR@0WY;hx|@{=j6QOd7l4xpWHlcZ6)^2
zzHcB15<C8rg&hQKiGv`Kk6&*CcaHW9Pk@Up4()`q5A?!?T?)Dkow|g(>KBOf^Kn-W
zy&M$m6BwYasjZ3Byc!sc)7M98dR`9IQpX^X9-f|hURrvGmA!GetHFi{g#W)^)C>&5
zAQoLaF<|f=SARMe3_;?T;EzZ?D$fUkWV4T3m^p;sXO8%%IIur7jYo<oguc8`7w7ER
zgumG1{*{P*eAP9r_g8vbEpyM@en#2W^0ZOstb0Y-6{@q=spq$J?(NSv%ThyDy4~|W
zFHs?pv{hZIO!;(CToWPrMg77xQ<(#3vvW-kUT)NWXWG%R_(9lJBfi4u*eQm#l@x)F
z?Q6Kw0M-_92igk#WC?A7zE_1rpj#4g5cKBjV^EyuR%PhekuAF+Wm%E0p<h$}7k+lv
zw9>Wd(c|)RZ9^lY!i>7wTKC?kr;rz$;=H}R^T*#panWZa(e)dPb;$7Lk2C%1(=}Qm
zgJS;v{#cqnsXsy%YBDPgWe&+4@%*VM!*&lG>Ppv^NAz3_M5EC>X5Kw21CPA}0*XHm
zR^X81qS<yw<9yDOCr<|23wB_jx<?Lb=mH1cAiJ}(6NLX;<XyMM^p%@|P+ZIZU`qa@
z#n+oRuv7ncTxh5z27_S-J+UhozXCy=H0`*NcLM`b8X6k?sL7z3fs<RHnW}`GgGtT^
z`suPf?YPMxgCQC%x2C2hL0uH$oOxn*^Uj?+eQ9IaTNV@S3M9cu1MLu`ubjPQ+yBw^
zC3%F`7a@{(tE;PPW?|vEYq5jcQ5P|&Nr2r}DmOGV1jC4z=b}lCI1WK01E(d?w)1Ft
zH4biDsf(snWMrg{o*wn;WvHp~nS)x-`}enaESi1O$Z56o90xTRztHv;`=&3+fV1}V
zUqxjXoh#q38!+rNfBCWA)sIawhB)t{jNb_BCE`<L-HzC3En(yV2&L*f@cgE2t|cXM
zsljpn$zy6?pJaOmf}3$n{D_d<yva3QaYJ<oM|U)Jziv&HV>EC_lM|I<^et2Ootd9}
zTp6|gse0i>yE~&bRj_5oY>I4}DIC%gvR`h-9uZlSl{<RHAw|KcYM?#to|e$lOHhCr
z-TFTMsr7?><zAhJ-n2UIXe1*^y;$Fy7T;~urrdYOqclcebTIyGiK_yCgNyQ}MQ$)j
z9{tbGZ1;~`zBVm$V<>3XfVjw@xmS0#!pRKH)c!)pw%U++6&1Q*V=0YEBegvU8<pKD
zbr?S|FrY8oTw%-=mJkvW67YDZ7oNw5L#P+Z+$l-kets$T)&@U#b={ZUDXp1uZDop*
zASOqrCnE@WJaKd405V{>`W~Nfx?4W}^m)Qdo(dHCdX2?kWO@*82Gz(*yIeK1u=xGN
z6B)e#mlQ=4!^LU_A)GrB=FyrWTNW@<>+S2COdt?4b$skxu1%&R{f8=MW@hjhVzh3R
zKTWDRQM{zFdaao$rf6L4MONzjbNh{7Hz^(gQ|t3)ay=$q|JHBTFkf7kQ&xt|4yWIo
z8L11iu#gY#Kw`TLrdu>f!`~G;mJm9#^xEL>fIlQ8SVe)+>MEvdez}O~*^^~hM(Z3W
zt|55WkNyVR=98i4kEC70|H0!h<w#>Ok&<W$v~3GmkoyLQSr#<;R-e_f2c8$+e)aOJ
zogSYi-XO8`mN~O6@-m+@6k5NtIziWOaQCTGr+P?%V{j~=K7H!#@1I&#RRv!FAt4&q
z++8A>m1TY(Ug$5?uh9GKZP>G)uKudO?NOC{d?jPoMe(`bJR4j{$QeYM3{qt@oRL~R
z`!tKgGXXk;jOMLonnp+X4OJYnOjA?{p6a+cUqTjm&_qq|dhEW^j&wrZ7g;cCP7q5*
zCreRy?D^c>T-B$ivZPj~yVK5<dr^un)TyZC*cG&xi<?MFNR%{ioQ?Uby|$8Q3k$!o
zMw8IRVOh~_yYd49DM@?FuJk_x>B$ce9n}7_4nZPtBOz2u*8?L4$ZfJJL0^Sn!Wj%-
zC~Ko<M=sus;qxfARtkH;Ao!Z#X-kWism?4$<k*I*j;?O&yGQ1KycXPTqNmxg`W}z3
zp2<n3ulCxc+1r>LCFs-fYYZi!Q@fk^T=t(kGX82f-dcbBhEw&`@c^or?2+%gP{Pe{
zKAY+>-Sxm$Gow)HmcgZ0H^O01jMRqojE*XrC+xbZnr8fh*8tMNnz(JlnJ9r0b^g5x
z!*`%UWRUJHih;h~-gr>DKwuIbzq<B05hmS#rys4GAIdRp@#3a{JdT~pjD2xrV<8n<
zFtg9IP6csQ=<^>1bb+Ppb&Q&$YB-fDXU7WG<9X%WHtlZXJ$v^5tUp7G{`BSmW1+m;
zbcQzh5h<KPsh0<G=6?$l;XVX_bsQUtDXr&oXmHfyYdgE`fSftHUYmRv7`8Ii$pVN~
zTxA9=XU47&(?95KuwTmpP(*SToN94C#_T?OEQ=!DMv-=t&(ifz!sCSkE}509#6Q?d
zP>=%v3mpy{i|)5EN&5rxF1Q{v(yJp=pOK>NKG#>!)6*jnD_9|VjMiUcy;U!9Ak}#H
z<U~8$I668GgKWXoE~D-BvrBO2(K3+ZIc7IX81?f5!=raJFYFsz?+SAtuEw%J?)0kw
z&S{}j9e4NaIbfZ#W6%DUj=S279xJ6(qow-bG*s~9+jJ!0SXerWxm>a^n$6j+7_KZ>
z5(*HlX-Z0{&2e!?5or``!k<<}`TdYR{pNw}{1_%cB>h=oangb8a20ska!fbjRF>`;
z(gwg0vzLFYTkEf=rfbKUcy6w-upP)Yiy9ZgPR(j%6_tH*avt*oMc7tZOv_A9E`wmS
zhzC*81A&kL_mcrqVLCc~dp{-J(Nz|>PMEF2IUg_{v?_mO)Y`HPU~dbHkgWLa;-h)&
zj!dMgV$|}>YT!jZ-aRzy0d@rr_2F|bzK`H8Dg@TEER8ppo69`k+^U|s=L_VGlBzc<
zV-&i8-&i7}R8$mWH(Awl&kE^Pw1DI?kG57&wclxDx>69a>+RT;PQBO#3|JLd@O_D7
zDUD~v+-CMz#C#E}NmRV08)QsI*Ut%_0tq94-S3#|MvlQw-Nm$m!185GB5)~yMgpqG
z6T%m3rs-6&AOwfQwE)ic0BPuF666g&K^&>=S?hYjb9bZ5-ALbX&I5&(kU&R9ZnOoQ
zuMfvcNKojM<U;DHY~va*kX-0SEm#u$@oj50Ko{p47E5CJzSy<#MCtRS01aTH&stcN
zU2eZ)QanDD6{y+BsVs?}b4CET)3>A6%mCNG{0m~SH_e3O#O8>}=}M-irc%Jx?SNJ2
zcwj`r<LQ$bZpAU3OEKI!`k+Tzk*gw*6f6L}BO)v$WbXlDR1nhV{o{sWxMI=d7=CEo
zBB&X)6Hn||9opRvCA3OkN9_CK2lkTJI|H9lFNA)$OvyxgBmq*Air(O8fC8$eRz`c<
zY+UcoULVt5AvRkrg_V!3l)Fh1jfKS3wFkdw#~tOo+KI3jYm8=aXn|=t2Z8$>tnxn(
zQ{~xW7g<n=?kVyHM}QBI1`2ZN=WJtx{nqzo8X~!)OT-#r1wfUj1a}$aMT|6E7xe%I
z^G7XA+&T$p_{ozWtWDP^=BV<Z3i|C=fatU%$nvDo2wye_sI&h3^Ku}|dq<qRPa+y5
zX{5k3^5!IhMI!TyB2YRyIxQ&SdiNZ)Guy-nMtO!y&~X^$*tduB7N|=${J-Gf+vyAW
z`T<$!0bT}dKDD*A)%(hoB;W>MMFy9H=_gn~=36VNu5#^nG?G`kj1bl)?7qQjEF(tP
zA@0@=Uag?9`8+m_8KMZr7-4c;8zRtvA1tDl4R2kj3#D92RH&j+qgFpP4wharU!Cop
z_TV;O&bS~o4U{3kjrQ){Zm>nb1S3qMIsY#P^z8&h)|Y2PoHJW}B%x~AA{SUMp*Mo-
zbtRY7)EGRqAu0k%Oanlt0L*%H-8X>CU<sQ=^jcdUmyq~FOqmtEDk|>O;tMc&wM@LZ
z&GnH3Ng#|jC${CFlj(9}YnE&tC0ROl0g)!GByC)5BPd`6>(gz3TB@l_4ZOL++*qLi
z2{bkH$mJ9FLx+5jeuJeA0U11ZL1*k)udxNHDh7&tS9+=0y(b3^lOW6$IS1*mms($$
zZhL;N9A1G0>m_YcDPrak9v{xEq|#^eh{cWCez27Yp6-&-x_B%kOa1I~{F%bDXe%qL
z5IN$+jXl=*@-9R5fO=MIKCs07{d>u46ofm-M1LN{p@2{_U~xt9XKh#jQ>`OmV+t^!
z@<z8Wk%cjbf#4V#8p3u3%bU$>yRl=B``h0Sv53OW1Hkk+PHnEQFaV$kc=1uJZs2Hr
z_-c<8BS9_z57bFpvu5JfU`;S4q)txP51-*0aR?p@#AjnO@||`EdA<AXLKeTaFBqY>
zxjDO-b<7o57<!=_|4Pr`pcBA4I7|av(8Xid%;6I`jO_SrVrsnAS^KD!tg*vMIR^zm
zjilk50G~jzlkEx|Tw>NIDFg*0@HDCDJV|Oyz#%11O--q&Bmv{e#1;uRe*6fYrK>wi
zxvjr-Oltnt=s7S5s!1ZE+a%Laf^aqm2D6n?^lAVt6BQf7BCD4BQj6(%D85h6(2(=$
z(ipjV^HY1WPw&&cWBkQ16f34~v35S`y6AQ(3ESbQl}^wapkxI$o&&(G0o{dz1jD&}
z`f{^40{GsuAgmA90A-$m2g=mOSck{~(`JqIeEq9CFtljfsAZLjL-tQ4i;9ZS7LsIM
ze+j2nX>H-Iut8f$j8$qF>lAE{2;y)nlmr=i*Co;Bwwv9F-}Y#vpZLMq**T}7!Q@_6
zR#+WVNw{VOS6o>*iw=uJUO-`Cp}K1<pAF~b_x8yVQ=N)~Nlv7I3l$_%+pqsHr@sbl
z=}m41B)=3c<a1$ny20K@NaOLSWW_vUOvL7=4DxWv(ilKuJ$v9h()-=RHM%r8ylH-R
zG3Mh(m>S9#hnKvBqT3@ms;1XaQSTXHQm&#-2O`*WdsQt{1{wZhVqzd!xh|SYtHj7n
zR@)MnTkJ+Qg|+?m{!>7oLHt`^{jyVhM)*Kp$NTiIeLCJ`GSU3@x-f3NyKN!1X@P4j
z@;b(7p|sh3{M9ck+L%DM7W8xa@@-kbR-AG3-bKVr5ubMmrsE+`a`gC4w?QU(=K9Ya
zsB?Gu-P@PogL|uNQ}^Jf$#&m{8-2sV%1J?q1~=BfM(Eql7rxp05##x>>3YA7PF~f$
zd-vSI_exhwwJCB;rZ5{Lm`_|EGg1-_hD@3M6ToyBJQP+X#(RKYA#pSBoDr%DD{e|1
zvHqDtUMXpvi`3e(94Dg;>92-wa`x|r;&5N0*#n<G<xhZSR&IHDc|?s}LEqJ*5VX-I
z+Y|uPFX&m!5rb-6=6?`@aOcf|J{C!1^9Ornn}9E6GMPQY!!FI~BGAS&y8?@oCr{3`
z1=@&&nHM-D0Tj(&h9LRfHX@?`?;L*V9_ioukm~6t#2iJT(pYfBN`TLFK0XD4LmBOr
zuHQk&NJoKl>5Gs^Ofq>OayX+MK7@c1+ff%;sI){a{X|7Y#p9Swj^tH6a5@HJTj{zD
zY7${dYJJJB%$KOu|ANl*-{1yVRz(G*py<w42-lmKMgxfo|DjS9^mvPkGy>|FRcRO8
zG&6il_dy?z)dS-LI#PD?m-{Tte=~@!n*~i{lHZ5#;4}46-+{*p4<l?p_lt)rec{&Q
zK>P8|#(V_FieHMDgPU8s6byBM#>!hMUh^!<u;0@Kg?`5BYT5jGXJ`42ker&D4~_YI
zIOymy)Lde;Eh>WjcH=C*o@@Xev-{lZ4~KwIZZ2R@G)C{M)x#S(F@w@<iXdN!g9h`|
l@7M|{D`5W1|0(DYiZT@pzeV*#0*-^A<7jJ(;vX;m^I!BPD2@OC

literal 0
HcmV?d00001

diff --git a/lib/matplotlib/tests/test_offsetbox.py b/lib/matplotlib/tests/test_offsetbox.py
index c77384ffcdba..72fdbdbf2e3b 100644
--- a/lib/matplotlib/tests/test_offsetbox.py
+++ b/lib/matplotlib/tests/test_offsetbox.py
@@ -12,8 +12,8 @@
 from matplotlib.backend_bases import MouseButton
 
 from matplotlib.offsetbox import (
-        AnchoredOffsetbox, AnnotationBbox, DrawingArea, OffsetImage, TextArea,
-        _get_packed_offsets)
+        AnchoredOffsetbox, AnnotationBbox, AnchoredText, DrawingArea,
+        OffsetImage, TextArea, _get_packed_offsets)
 
 
 @image_comparison(['offsetbox_clipping'], remove_text=True)
@@ -241,6 +241,21 @@ def test_picking(child_type, boxcoords):
     assert len(calls) == 0
 
 
+@image_comparison(['anchoredtext_align.png'], remove_text=True, style='mpl20')
+def test_anchoredtext_horizontal_alignment():
+    fig, ax = plt.subplots()
+
+    text0 = AnchoredText("test\ntest long text", loc="center left",
+                         pad=0.2, prop={"ha": "left"})
+    ax.add_artist(text0)
+    text1 = AnchoredText("test\ntest long text", loc="center",
+                         pad=0.2, prop={"ha": "center"})
+    ax.add_artist(text1)
+    text2 = AnchoredText("test\ntest long text", loc="center right",
+                         pad=0.2, prop={"ha": "right"})
+    ax.add_artist(text2)
+
+
 def test_annotationbbox_extents():
     plt.rcParams.update(plt.rcParamsDefault)
     fig, ax = plt.subplots(figsize=(4, 3), dpi=100)