a ضa @sNdZddlZddlZddlZddlZddlZddlm Z m Z m Z m Z ddl m Z ddlmZddlmZmZmZddlmZdd lmZmZmZmZmZmZeeZd d Z d d Z!e j"e #dgdgddgdgdgdgdgdgdgdgdgdgd Gddde Z$GdddZ%Gd d!d!Z&Gd"d#d#e$e&Z'e j"j(e'j)jd$dS)%z) Classes for including text in a figure. N)_apiartistcbook docstring)Artist)FontProperties)FancyArrowPatchFancyBboxPatch Rectangle)TextPath)Affine2DBboxBboxBaseBboxTransformToIdentityTransform Transformc Cszt|dWSttfy}zXt|ds6|durDWYd}~dSt|dr^WYd}~dStd||WYd}~n d}~00dS)a* Return *rotation* normalized to an angle between 0 and 360 degrees. Parameters ---------- rotation : float or {None, 'horizontal', 'vertical'} Rotation angle in degrees. *None* and 'horizontal' equal 0, 'vertical' equals 90. Returns ------- float hZ horizontalNZverticalgV@zRrotation is {!r}; expected either 'horizontal', 'vertical', numeric value, or None)float ValueError TypeErrorr _str_equalformat)rotationerrr_/Users/vegardjervell/Documents/master/model/venv/lib/python3.9/site-packages/matplotlib/text.py get_rotations rcCsg}g}t|}t| }||\}}}|D]\\} } } } | \} }|| | f\}}||8}|| ||}}|||g|||gq8t|t|}}t ||t ||}}t|||f\}}||||fS)z Calculate the bounding box of the text. The bbox position takes text rotation into account, but the width and height are those of the unrotated box (unlike `.Text.get_window_extent`). ) npZdeg2radrr rotate _get_layout transformextendminmax)textrendererZ projected_xsZ projected_ysthetatr_partsdtwhxywhZxt1Zyt1Zxt2Zyt2Zxt_boxZyt_boxw_boxh_boxx_boxy_boxrrr _get_textbox4s r7cfamilyfontZfont_propertiesZhamanamesizestretchstylevariantvaweight) color fontfamilyfontpropertieshorizontalalignmentmultialignmentfontnamefontsizeZ fontstretch fontstyleZ fontvariantverticalalignmentZ fontweightcseZdZdZdZedZddZdd d fdd Z fddZ fddZ ddZ ddZ ddZddZddZddZd d!Zfd"d#Zdd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zfd0d1Zdfd2d3 Zfd4d5Zd6d7Zd8d9Zd:d;Zdd?Z!d@dAZ"e#j$dBdCZ%dDdEZ&dFdGZ'dHdIZ(dJdKZ)dLdMZ*dNdOZ+dPdQZ,dRdSZ-dTdUZ.dVdWZ/dXdYZ0dZd[Z1e23d\dd]d^Z4d_d`Z5dadbZ6ddcddZ7dedfZ8dgdhZ9didjZ:dkdlZ;dmdnZdsdtZ?dudvZ@dwdxZAdydzZBd{d|ZCd}d~ZDddZEddZFddZGddZHddZIddZJddZKddZLddZMddZNddZOddZPddZQddZRZSS)TextzAHandle storing and drawing of text in window or data coordinates.2cCsd|j|jt|jfS)NzText(%s, %s, %s))_x_yrepr_textselfrrr__repr__psz Text.__repr__rNbaselineleftFT) parse_mathc st|||_|_d|_||||dur8|ntjd| || | | || | | |||||_| |_||_d|_d|_| durd} | |_|| ||dS)z Create a `.Text` instance at *x*, *y* with string *text*. Valid keyword arguments are: %(Text:kwdoc)s rVNz text.colorg333333?)super__init__rOrPrRset_text set_colormplrcParamsset_fontproperties set_usetexset_parse_mathset_wrapset_verticalalignmentset_horizontalalignment_multialignment _rotation_transform_rotates_text _bbox_patch _renderer _linespacingset_rotation_modeupdate)rTr/r0r&rCrKrFrGrErZ linespacing rotation_modeusetexwrapZtransform_rotates_textrYkwargs __class__rrr[ss.         z Text.__init__cs^t|t}t}|d|}||ur0|||d|}t|||urZ||dS)NrEbbox) rZnormalize_kwargsrLobjectpopr`rZrmset_bbox)rTrqsentinelrErtrrrrrms     z Text.updatecst}d|d<|S)Nrj)rZ __getstate__)rTr,rrrrrys zText.__getstate__cCs||\}}|dur||fS|r0|jdur8difSt|}|j|jkoZ|jkno||j|j kox|j kn}i}|j r|j |\}}|p|}||d<||fS)zs Return whether the mouse event occurred inside the axis-aligned bounding-box of the text. NFZ bbox_patch) _default_contains get_visiblerjrLget_window_extentx0r/x1y0r0y1ricontains)rTZ mouseeventinsideinfortZcattrZ patch_insideZ patch_cattrrrrrs z Text.containscCs|\}}|||fS)zW Get the (possibly unit converted) transformed x, y in display coords. )get_unitless_position get_transformr"rTr/r0rrr_get_xy_displays zText._get_xy_displaycCs|jdur|jS|jSdSN)rf_horizontalalignmentrSrrr_get_multialignments zText._get_multialignmentcCsR|rDt|j}|\}}|g}||gg}|||dSt|jSdS)z3Return the text angle in degrees between 0 and 360.rN)get_transform_rotates_textrrgrrZtransform_anglesitem)rTangler/r0ZanglesZptsrrrrs   zText.get_rotationcCs|jS)zV Return whether rotations of the transform affect the text direction. )rhrSrrrrszText.get_transform_rotates_textcCs"tjgd|d||_d|_dS)aW 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. )anchordefaultN)rnTN)r check_in_list_rotation_modestale)rTmrrrrls zText.set_rotation_modecCs|jS)zReturn the text rotation mode.)rrSrrrget_rotation_modeszText.get_rotation_modecsjt||j|_|j|_|j|_|j|_|j|_|j|_|j |_ |j |_ |j |_ |j |_ d|_ dS)NT)rZ update_from_colorrf_verticalalignmentr_fontpropertiescopy_usetexrgrhZ_pickerrkr)rTotherrrrrrs  zText.update_fromcCsR|\}}|p|j}|||t|j|j|j|j|j|j |j |j j t |f S)z Return a hashable tuple of properties that lets `_get_layout` know whether a previously computed layout can be reused. )rrjget_texthashrrrrkrgrrhfiguredpiweakrefrefrTr'r/r0rrr_get_layout_cache_keys   zText._get_layout_cache_keyc-s4|j|d}||jvr |j|Sd\}}|d}g}g}g}g} |jd|j|r\dndd\} } } | | |j} t|D]\}}| |\}}|r|j||j|d\}}}n d}}}t || }t || }| || ||||}|dkr || }n|t | |||j8}| || |||8}q|}t |d}}d}| d |}||}t |}|}|d krd d t|| D}nJ|d krʇfdd t|| |D}n$|dkrfdd t|| |D}t||f||f||f||fg}||} | dddf}| dddf }| dddf}| dddf }||||}|j}!|j}"|}#|#dkr"|!d kr||d}$n|!dkr|}$n|}$|"d kr||d}%nD|"dkr|}%n4|"dkr||}%n |"dkr|||d}%n|}%n|d\}&}'|d\}(})|!d krR|&|(d}$n|!dkrb|(}$n|&}$|"d kr~|'|)d}%n@|"dkr|)}%n0|"dkr|)|}%n|"dkr|)|d}%n|'}%||$|%f\}$}%||$8}||%8}t|||}*|||$|%f}+|*tt|t||g|+jR|f},|,|j|<|,S)z Return the extent (bbox) of the text together with multiple-alignment information. Note that it returns an extent of a rotated text when necessary. )r')rr ZlpTeXF)ismathrrXcSsg|]\}}||fqSrr).0r/r0rrr kz$Text._get_layout..centercs*g|]"\}}}|d|d|fqS)rrr/r0r1widthrrrmsrightcs"g|]\}}}|||fqSrrrrrrrpsNrrrtoprWcenter_baselineg@)r_cachedrsplitget_text_width_height_descentr get_usetexrk enumerate_preprocess_mathr%appendr rotate_degrrziprarrayr"r$rrrr from_boundslistT)-rTr'keyZthisxZthisylineswsZhsxsZysr*Zlp_hZlp_dZmin_dyiline clean_linerr1r2r,rWdescentZxminZxmaxZymaxZyminheightMZmalignZ offset_layoutZ corners_horizZcorners_rotatedZhalignZvalignrnZoffsetxZoffsetyZxmin1Zymin1Zxmax1Zymax1rtZxysretrrrr!"s                                         $ zText._get_layoutcCs|dur|}|dd}|dd}|durNd}|dur@d}||}n |durZd}t|trxd|vrx|d|7}td|td ||_nd|_|dS) a 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)) NboxstylepadZsquareg333333?z ,pad=%0.2f)rrrr)rr") rrvget_size isinstancestrr rri_update_clip_properties)rTZ rectpropspropsrrrrrrws(    z Text.set_bboxcCs|jS)zf Return the bbox Patch, or None if the `.patches.FancyBboxPatch` is not made. )rirSrrrget_bbox_patchszText.get_bbox_patchc Cs|jrt||j}t||j}|||f\}}t||\}}}}|j dd|||j t | ||||||}|j|dS)z 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. rN)rirconvert_xunitsrOconvert_yunitsrPrr"r7Z set_bounds set_transformr rr translatepoints_to_pixelsrset_mutation_scale) rTr'posxposyr5r6r3r4Zfontsize_in_pixelrrrupdate_bbox_position_sizes zText.update_bbox_position_sizecCs*t|j|j|jd}|jr&|j|dS)N)Zclip_boxZ clip_pathclip_on)dictclipboxZ _clippathZ_cliponrirm)rTZ clippropsrrrrs zText._update_clip_propertiescst||dSr)rZ set_clip_boxr)rTrrrrrr s zText.set_clip_boxcst|||dSr)rZ set_clip_pathr)rTpathr"rrrrrszText.set_clip_pathcst||dSr)rZ set_clip_onrrTbrrrrrs zText.set_clip_oncCs|jS)z'Return whether the text can be wrapped._wraprSrrrget_wrapsz Text.get_wrapcCs ||_dS)a Set whether the text can be wrapped. 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. Nr)rTrprrrrcsz Text.set_wrapc Cs||\}}|}|}|d|}|||||}|d|d|||}|dkrr|}n|dkr|}ndt ||}|S)zk Return the maximum line width for wrapping text based on the current orientation. rrrXrr) rr" get_positionZ get_figurer|get_horizontalalignmentrlr_get_dist_to_boxr$) rTr}r figure_box alignmentrrXr line_widthrrr_get_wrap_line_width1s  zText._get_wrap_line_widthcCs|dkrD|d}|tt|}|j|ttd|}n|dkr|d}|tt|}|ttd|}n||dkr|d}|j|tt|}|ttd|}n8|j|tt|}|j|ttd|}t||S)zr Return the distance from the given points to the boundaries of a rotated box, in pixels. iZr)mathcosradiansr~rr$)rTrr}rrZquadh1h2rrrrKs zText._get_dist_to_boxcCs$|j||d\}}}t|S)zE Return the width of a given text string, in pixels. F)rjrget_fontpropertiesrceil)rTr&r1r2r,rrr_get_rendered_text_widthbs  zText._get_rendered_text_widthc Cs|s|S|r |S|}g}|d}|D]}|d}t|dkr>t|dkrv||dqLtdt|dD]}d |d|}| |}||kr|d |d|d||dd}qLq|t|kr|d |d|g}qLqqLq>d |S)z 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). r rrrN) rrrrrlenrrvrangejoinr) rTrZ wrapped_linesZunwrapped_linesZunwrapped_lineZ sub_wordsrrZ current_widthrrr_get_wrapped_textls2      zText._get_wrapped_textc Cs2|dur||_|sdS|dkr*dS|d||j|d||\}}}|}t | |j }t | |j }|||f\}}t|rt|stdWddS|\}} |jr|||j||} | || || |j|| |} |D]\} } }}t |dkrR|nd}||}||}|!rx| |}|"| \}}|#rddl$m%}||#|}n|}|&r|j'| ||||j(| |dn|j)| ||||j(| ||d q4Wdn1s 0Y| *|+dd |_,dS) NrVr&)r&z%posx and posy should be finite valuesrr)PathEffectRenderer)mtext)rrF)-rjr{rZ open_groupZget_gidZ_cm_setrr!rrrrOrrPr"risfinite_logwarningZget_canvas_width_heightrirdrawZnew_gcZset_foreground get_colorZ set_alphaZ get_alphaZset_url_urlZ _set_gc_cliprrZflipyrZget_path_effectsZmatplotlib.patheffectsrrZdraw_texrZ draw_textrestoreZ close_groupr)rTr'rtrrtransrrZcanvaswZcanvashgcrrr.r/r0rrrrZ textrendererrrrrsf             * z Text.drawcCs|jS)zReturn the color of the text.)rrSrrrrszText.get_colorcCs|jS)z*Return the `.font_manager.FontProperties`.)rrSrrrrszText.get_fontpropertiescCs |jS)z Return the list of font families used for font lookup. See Also -------- .font_manager.FontProperties.get_family )rZ get_familyrSrrrget_fontfamilyszText.get_fontfamilycCs |jS)z Return the font name as a string. See Also -------- .font_manager.FontProperties.get_name )rget_namerSrrr get_fontnameszText.get_fontnamecCs |jS)z Return the font style as a string. See Also -------- .font_manager.FontProperties.get_style )rZ get_stylerSrrr get_fontstyleszText.get_fontstylecCs |jS)z Return the font size as an integer. See Also -------- .font_manager.FontProperties.get_size_in_points )rZget_size_in_pointsrSrrr get_fontsize szText.get_fontsizecCs |jS)z Return the font variant as a string. See Also -------- .font_manager.FontProperties.get_variant )rZ get_variantrSrrrget_fontvariantszText.get_fontvariantcCs |jS)z Return the font weight as a string or a number. See Also -------- .font_manager.FontProperties.get_weight )rZ get_weightrSrrrget_fontweightszText.get_fontweightcCs |jS)z Return the font stretch as a string or a number. See Also -------- .font_manager.FontProperties.get_stretch )r get_stretchrSrrrr)szText.get_stretchcCs|jS)zs Return the horizontal alignment as a string. Will be one of 'left', 'center' or 'right'. )rrSrrrr3szText.get_horizontalalignmentcCs(t||j}t||j}||fS)z0Return the (x, y) unitless position of the text.)rrrOrrPrrrrr:szText.get_unitless_positioncCs |j|jfS)z'Return the (x, y) position of the text.)rOrPrSrrrrBszText.get_positionz3.5cCsV|\}}|p|j}||||j|j|jt|j|j|j |j |j j t ||jf S)z 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. )rrjrrrrrrrgrrhrrrrrkrrrr get_prop_tupIs  zText.get_prop_tupcCs|jS)zReturn the text string.)rRrSrrrr]sz Text.get_textcCs|jS)z Return the vertical alignment as a string. Will be one of 'top', 'center', 'bottom', 'baseline' or 'center_baseline'. )rrSrrrget_verticalalignmentaszText.get_verticalalignmentc Cs&|stS|dur |jj}|dkrxtj|j|d,|\}}t ||ddWdS1sn0Y|dur||_ |j dur|jj |_ |j durt dtj|j|dT| |j \}}}|\}} ||| f\}} ||| }|WdS1s0YdS)a 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. NrV)rr%Cannot get window extent w/o renderer)r{runitrrrrZ _setattr_cmrrrj_cachedRenderer RuntimeErrorr!rrr"Z translated) rTr'rZtxtyrtrrr/r0rrrr|hs(  .     zText.get_window_extentcCsB|jdur|t||dn|jt|d|d|_dS)z Set the background color of the text by updating the bbox. Parameters ---------- color : color See Also -------- .set_bbox : To change the position of the bounding box N) facecolorZ edgecolor)rT)rirwrrmrrrTrCrrrset_backgroundcolors zText.set_backgroundcolorcCsRt|dstjj|dz t|Wnty@t|}Yn0||_d|_ dS)zs Set the foreground color of the text Parameters ---------- color : color auto)rCTN) rrr^colorsZ_check_color_likerrtuplerrrrrrr]s   zText.set_colorcCs"tjgd|d||_d|_dS)z Set the horizontal alignment to one of Parameters ---------- align : {'center', 'right', 'left'} rrrXalignTN)rrrrrTr"rrrreszText.set_horizontalalignmentcCs"tjgd|d||_d|_dS)al Set the text alignment for multiline texts. The layout of the bounding box of all the lines is determined by the horizontalalignment and verticalalignment properties. This property controls the alignment of the text lines within that box. Parameters ---------- align : {'left', 'right', 'center'} r r!TN)rrrfrr#rrrset_multialignments zText.set_multialignmentcCs||_d|_dS)z Set the line spacing as a multiple of the font size. The default line spacing is 1.2. Parameters ---------- spacing : float (multiple of font size) TN)rkr)rTspacingrrrset_linespacings zText.set_linespacingcCs|j|d|_dS)a Set the font family. May be either a single string, or a list of strings in decreasing priority. Each string may be either a real font name or a generic font class name. If the latter, the specific font names will be looked up in the corresponding rcParams. If a `Text` instance is constructed with ``fontfamily=None``, then the font is set to :rc:`font.family`, and the same is done when `set_fontfamily()` is called on an existing `Text` instance. Parameters ---------- fontname : {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'} See Also -------- .font_manager.FontProperties.set_family TN)r set_familyrrTrHrrrset_fontfamilys zText.set_fontfamilycCs|j|d|_dS)z Set the font variant. Parameters ---------- variant : {'normal', 'small-caps'} See Also -------- .font_manager.FontProperties.set_variant TN)rZ set_variantr)rTr@rrrset_fontvariants zText.set_fontvariantcCs|j|d|_dS)z Set the font style. Parameters ---------- fontstyle : {'normal', 'italic', 'oblique'} See Also -------- .font_manager.FontProperties.set_style TN)rZ set_styler)rTrJrrr set_fontstyle s zText.set_fontstylecCs|j|d|_dS)a Set the font size. Parameters ---------- fontsize : float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} If float, the fontsize in points. The string values denote sizes relative to the default font size. See Also -------- .font_manager.FontProperties.set_size TN)rZset_sizer)rTrIrrr set_fontsizes zText.set_fontsizecCs |jS)z Return the font family name for math text rendered by Matplotlib. The default value is :rc:`mathtext.fontset`. See Also -------- set_math_fontfamily )rget_math_fontfamilyrSrrrr-.s zText.get_math_fontfamilycCs|j|dS)a Set the font family for math text rendered by Matplotlib. This does only affect Matplotlib's own math renderer. It has no effect when rendering with TeX (``usetex=True``). Parameters ---------- fontfamily : str The name of the font family. Available font families are defined in the :ref:`matplotlibrc.template file `. See Also -------- get_math_fontfamily N)rset_math_fontfamily)rTrDrrrr.:szText.set_math_fontfamilycCs|j|d|_dS)ab Set the font weight. Parameters ---------- weight : {a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'} See Also -------- .font_manager.FontProperties.set_weight TN)rZ set_weightr)rTrBrrrset_fontweightPs zText.set_fontweightcCs|j|d|_dS)a Set the font stretch (horizontal condensation or expansion). Parameters ---------- stretch : {a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'} See Also -------- .font_manager.FontProperties.set_stretch TN)rZ set_stretchr)rTr>rrrset_fontstretchas zText.set_fontstretchcCs ||d||ddS)z} Set the (*x*, *y*) position of the text. Parameters ---------- xy : (float, float) rrN)set_xset_y)rTxyrrr set_positionrszText.set_positioncCs||_d|_dS)zl Set the *x* position of the text. Parameters ---------- x : float TN)rOr)rTr/rrrr1}sz Text.set_xcCs||_d|_dS)zl Set the *y* position of the text. Parameters ---------- y : float TN)rPr)rTr0rrrr2sz Text.set_ycCs||_d|_dS)a" Set the rotation of the text. Parameters ---------- s : float or {'vertical', 'horizontal'} The rotation angle in degrees in mathematically positive direction (counterclockwise). 'horizontal' equals 0, 'vertical' equals 90. TN)rgrrTsrrr set_rotations zText.set_rotationcCs||_d|_dS)z Whether rotations of the transform affect the text direction. Parameters ---------- t : bool TN)rhr)rTr-rrrset_transform_rotates_textszText.set_transform_rotates_textcCs"tjgd|d||_d|_dS)z Set the vertical alignment. Parameters ---------- align : {'center', 'top', 'bottom', 'baseline', 'center_baseline'} )rZbottomrrWrr!TN)rrrrr#rrrrds zText.set_verticalalignmentcCs*|dur d}||jkr&t||_d|_dS)a1 Set the text string *s*. It may contain newlines (``\n``) or math in LaTeX syntax. Parameters ---------- s : object Any object gets converted to its `str` representation, except for ``None`` which is converted to an empty string. NrVT)rRrrr5rrrr\s   z Text.set_textcCsR|r|dkrd}|dfS|s,|dfSt|r>|dfS|dddfSdS) a  Return the string *s* after mathtext preprocessing, and the kind of mathtext support needed. - If *self* is configured to use TeX, return *s* unchanged except that a single space gets escaped, and the flag "TeX". - Otherwise, if *s* is mathtext (has an even number of unescaped dollar signs) and ``parse_math`` is not set to False, return *s* and the flag True. - Otherwise, return *s* with dollar signs unescaped, and the flag False. rz\ rFTz\$$N)rget_parse_mathrZ is_math_textreplacer5rrrrs  zText._preprocess_mathcCst||_d|_dS)ar Set the font properties that control the text. Parameters ---------- fp : `.font_manager.FontProperties` or `str` or `pathlib.Path` If a `str`, it is interpreted as a fontconfig pattern parsed by `.FontProperties`. If a `pathlib.Path`, it is interpreted as the absolute path to a font file. TN)rZ _from_anyrrr)rTfprrrr`s zText.set_fontpropertiescCs*|durtjd|_n t||_d|_dS)z Parameters ---------- usetex : bool or None Whether to render using TeX, ``None`` means to use :rc:`text.usetex`. Nz text.usetexT)r^r_rboolr)rTrorrrras zText.set_usetexcCs|jS)z9Return whether this `Text` object uses TeX for rendering.)rrSrrrrszText.get_usetexcCst||_dS)a0 Override switch to disable any mathtext parsing for this `Text`. Parameters ---------- parse_math : bool If False, this `Text` will never use mathtext. If True, mathtext will be used if there is an even number of unescaped dollar signs. N)r= _parse_math)rTrYrrrrbs zText.set_parse_mathcCs|jS)z>Return whether mathtext parsing is considered for this `Text`.)r>rSrrrr:szText.get_parse_mathcCs ||S)a- Alias for `set_family`. One-way alias only: the getter differs. Parameters ---------- fontname : {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'} See Also -------- .font_manager.FontProperties.set_family )r'r(rrr set_fontnameszText.set_fontname)rrrVNrWrXNNNNNNFF)N)N)N)NN)T__name__ __module__ __qualname____doc__ZzorderrmaxdictrrUr[rmryrrrrrrlrrrr!rwrrrrrrrrcrrrrrallow_rasterizationrrrr r rrrrrrrrr deprecatedrrrr|rr]rer$r&r)r*r+r,r-r.r/r0r4r1r2r7r8rdr\rr`rarrbr:r? __classcell__rrrrrrL[s /     (   3 E         ,         rLc@s:eZdZdZdddZddZddZd d Zd d Zd S) OffsetFromz4Callable helper class for working with `Annotation`.pointscCs||_||_||dS)ab Parameters ---------- artist : `.Artist` or `.BboxBase` or `.Transform` The object to compute the offset from. ref_coord : (float, float) If *artist* is an `.Artist` or `.BboxBase`, this values is the location to of the offset origin in fractions of the *artist* bounding box. If *artist* is a transform, the offset origin is the transform applied to this value. unit : {'points, 'pixels'}, default: 'points' The screen units to use (pixels or points) for the offset input. N)_artist _ref_coordset_unit)rTrZ ref_coordrrrrr[)szOffsetFrom.__init__cCstjddg|d||_dS)z Set the unit for input to the transform used by ``__call__``. Parameters ---------- unit : {'points', 'pixels'} rIpixels)rN)rr_unit)rTrrrrrL?szOffsetFrom.set_unitcCs|jS)z@Return the unit for input to the transform used by ``__call__``.)rNrSrrrget_unitJszOffsetFrom.get_unitcCs"|}|dkrdS|dSdS)NrMg?)rOr)rTr'rrrr _get_scaleNszOffsetFrom._get_scalec Cst|jtrD|j|}|j\}}|j|j|}|j|j|}nft|jt r|j}|j\}}|j|j|}|j|j|}n(t|jt r|j |j\}}nt d| |}t|||}|S)aL Return the offset transform. Parameters ---------- renderer : `RendererBase` The renderer to use to compute the offset Returns ------- `Transform` Maps (x, y) in pixel or point units to screen units relative to the given artist. z unknown type)rrJrr|rKr}rrrrrr"rrPr scaler) rTr'rtZxfZyfr/r0Zscr)rrr__call__Us        zOffsetFrom.__call__N)rI) r@rArBrCr[rLrOrPrRrrrrrH&s   rHc@sXeZdZdddZddZddZd d Zd d Zd dZddZ ddZ dddZ dS)_AnnotationBasedataNcCs ||_||_||d|_dSr)r3xycoordsset_annotation_clip _draggable)rTr3rUannotation_cliprrrr[zs z_AnnotationBase.__init__cCs`t|tr|\}}n ||}}|dkr4t||}|dkrJt||}|||||fS)NrT)rrrrr_get_xy_transformr")rTr'r/r0r6s1s2rrr_get_xys   z_AnnotationBase._get_xycCsht|trD|\}}ddlm}|||}|||}|||}|St|r~||}t|trft|St|trt|St dnRt|t r| |} t| St|trt|St|tr|St|t st d||dkr|j jS|dkrddlm} | }||j j} | S|} t| dkr0td |d \} }| \}}|d krT|jj} n&|d krh|jj} n|d krz|j j} | dur| j}n|dkr||}|durX|\}}|dkr|jd}t|}nt|dkrt}nb|dkr|}||jd}t|}n0|dkr@| j\}}t||}n td ||||Std |dS)Nr)blended_transform_factoryzunknown return type ...zunknown coordinate type : %srTZpolar) PolarAxesrz!%s is not a recognized coordinate)NNrZ subfigureaxesoffsetrIgR@rMrIfraction) rrZmatplotlib.transformsr]rYcallablerrrrrr|rr_Z transDataZmatplotlib.projectionsr^ZPolarTransformrrrrZfigbboxrtZp0 _get_ref_xyZget_dpir rQrr=r)rTr'r6rZr[r]Ztr1Ztr2r)rtr^r Zs_Zbbox0Zxy0Z bbox_namerZref_xZref_yZdpprIr1r2rrrrYs|                                  z!_AnnotationBase._get_xy_transformcCs|j|g|j|jRS)z{ Return x, y (in display coordinates) that is to be used for a reference of any offset coordinate. )r\r3rUrTr'rrrrcsz_AnnotationBase._get_ref_xycCs ||_dS)a Set the annotation's clipping behavior. Parameters ---------- b : bool or None - True: the annotation will only be drawn when ``self.xy`` is inside the axes. - False: the annotation will always be drawn regardless of its position. - None: the ``self.xy`` will be checked only if *xycoords* is "data". NZ_annotation_cliprrrrrVsz#_AnnotationBase.set_annotation_clipcCs|jS)z Return the annotation's clipping behavior. See `set_annotation_clip` for the meaning of return values. rerSrrrget_annotation_clipsz#_AnnotationBase.get_annotation_clipcCs|j\}}|||||jS)z1Return the pixel position of the annotated point.)r3r\rUrrrr_get_position_xy s z _AnnotationBase._get_position_xycCs8|}|s|dur4|jdkr4||}|j|SdS)z;Check whether the annotation at *xy_pixel* should be drawn.NrTT)rfrUrgr_Zcontains_point)rTr'rZxy_pixelrrr _check_xys   z_AnnotationBase._check_xyFcCs`ddlm}|jdu}|dur$| }|r@|jdurZ||||_n|jdurT|jd|_|jS)a Set whether the annotation is draggable with the mouse. Parameters ---------- state : bool or None - True or False: set the draggability. - None: toggle the draggability. Returns ------- DraggableAnnotation or None If the annotation is draggable, the corresponding `.DraggableAnnotation` helper is returned. r)DraggableAnnotationN)Zmatplotlib.offsetboxrirWZ disconnect)rTstateZuse_blitriZ is_draggablerrr draggables     z_AnnotationBase.draggable)rTN)NF) r@rArBr[r\rYrcrVrfrgrhrkrrrrrSys  T rScseZdZdZddZd ddZdd Zed d Zej d d Zed dZ e j ddZ ddZ ddZ ee e ddZ ddZddZejddZd!ddZfddZZS)" Annotationa` An `.Annotation` is a `.Text` that can refer to a specific position *xy*. Optionally an arrow pointing from the text to *xy* can be drawn. Attributes ---------- xy The annotated position. xycoords The coordinate system for *xy*. arrow_patch A `.FancyArrowPatch` to point from *xytext* to *xy*. cCsd|jd|jd|jfS)NzAnnotation(%g, %g, %r)rr)r3rRrSrrr__str__LszAnnotation.__str__NrTc Kstj||||d|dur4|dur4||kr4td|durB|j}||_|durV|j}|\} } ||_|dur|}d|vr| dd|_ ndD]} | | dqt d i||_ nd|_ t j|| | |fi|dS) a Annotate the point *xy* with text *text*. In the simplest form, the text is placed at *xy*. Optionally, the text can be displayed in another position *xytext*. An arrow pointing from the text to the annotated point *xy* can then be added by defining *arrowprops*. Parameters ---------- text : str The text of the annotation. xy : (float, float) The point *(x, y)* to annotate. The coordinate system is determined by *xycoords*. xytext : (float, float), default: *xy* The position *(x, y)* to place the text at. The coordinate system is determined by *textcoords*. xycoords : str or `.Artist` or `.Transform` or callable or (float, float), default: 'data' The coordinate system that *xy* is given in. The following types of values are supported: - One of the following strings: ==================== ============================================ Value Description ==================== ============================================ 'figure points' Points from the lower left of the figure 'figure pixels' Pixels from the lower left of the figure 'figure fraction' Fraction of figure from lower left 'subfigure points' Points from the lower left of the subfigure 'subfigure pixels' Pixels from the lower left of the subfigure 'subfigure fraction' Fraction of subfigure from lower left 'axes points' Points from lower left corner of axes 'axes pixels' Pixels from lower left corner of axes 'axes fraction' Fraction of axes from lower left 'data' Use the coordinate system of the object being annotated (default) 'polar' *(theta, r)* if not native 'data' coordinates ==================== ============================================ Note that 'subfigure pixels' and 'figure pixels' are the same for the parent figure, so users who want code that is usable in a subfigure can use 'subfigure pixels'. - An `.Artist`: *xy* is interpreted as a fraction of the artist's `~matplotlib.transforms.Bbox`. E.g. *(0, 0)* would be the lower left corner of the bounding box and *(0.5, 1)* would be the center top of the bounding box. - A `.Transform` to transform *xy* to screen coordinates. - A function with one of the following signatures:: def transform(renderer) -> Bbox def transform(renderer) -> Transform where *renderer* is a `.RendererBase` subclass. The result of the function is interpreted like the `.Artist` and `.Transform` cases above. - A tuple *(xcoords, ycoords)* specifying separate coordinate systems for *x* and *y*. *xcoords* and *ycoords* must each be of one of the above described types. See :ref:`plotting-guide-annotation` for more details. textcoords : str or `.Artist` or `.Transform` or callable or (float, float), default: value of *xycoords* The coordinate system that *xytext* is given in. All *xycoords* values are valid as well as the following strings: ================= ========================================= Value Description ================= ========================================= 'offset points' Offset (in points) from the *xy* value 'offset pixels' Offset (in pixels) from the *xy* value ================= ========================================= arrowprops : dict, optional The properties used to draw a `.FancyArrowPatch` arrow between the positions *xy* and *xytext*. Defaults to None, i.e. no arrow is drawn. For historical reasons there are two different ways to specify arrows, "simple" and "fancy": **Simple arrow:** If *arrowprops* does not contain the key 'arrowstyle' the allowed keys are: ========== ====================================================== Key Description ========== ====================================================== width The width of the arrow in points headwidth The width of the base of the arrow head in points headlength The length of the arrow head in points shrink Fraction of total length to shrink from both ends ? Any key to :class:`matplotlib.patches.FancyArrowPatch` ========== ====================================================== The arrow is attached to the edge of the text box, the exact position (corners or centers) depending on where it's pointing to. **Fancy arrow:** This is used if 'arrowstyle' is provided in the *arrowprops*. Valid keys are the following `~matplotlib.patches.FancyArrowPatch` parameters: =============== ================================================== Key Description =============== ================================================== arrowstyle the arrow style connectionstyle the connection style relpos see below; default is (0.5, 0.5) patchA default is bounding box of the text patchB default is None shrinkA default is 2 points shrinkB default is 2 points mutation_scale default is text size (in points) mutation_aspect default is 1. ? any key for :class:`matplotlib.patches.PathPatch` =============== ================================================== The exact starting point position of the arrow is defined by *relpos*. It's a tuple of relative coordinates of the text box, where (0, 0) is the lower left corner and (1, 1) is the upper right corner. Values <0 and >1 are supported and specify points outside the text box. By default (0.5, 0.5) the starting point is centered in the text box. annotation_clip : bool or None, default: None Whether to draw the annotation when the annotation point *xy* is outside the axes area. - If *True*, the annotation will only be drawn when *xy* is within the axes. - If *False*, the annotation will always be drawn. - If *None*, the annotation will only be drawn when *xy* is within the axes and *xycoords* is 'data'. **kwargs Additional kwargs are passed to `~matplotlib.text.Text`. Returns ------- `.Annotation` See Also -------- :ref:`plotting-guide-annotation` )rUrXNzgYou have used the `textcoords` kwarg, but not the `xytext` kwarg. This can lead to surprising results. arrowstyleZrelpos)?ro)r headwidth headlengthshrinkfracrrr)rrt)rSr[r warn_externalrU _textcoordsr3 arrowpropsrrv _arrow_relposr arrow_patchrL) rTr&r3xytextrUZ textcoordsrwrXrqr/r0rrrrr[Os8. zAnnotation.__init__cCsX||\}}|dur||fSt||\}}|jdurP|j|\}}|pN|}||fSr)rzrLrry)rTeventrrrZtinfoZin_patchr*rrrr#s zAnnotation.containscCs|jSr) _xycoordsrSrrrrU-szAnnotation.xycoordscCs:dd}t|tr tt||s(||r0td||_dS)NcSst|to|dS)Nr`)rr startswith)r6rrr is_offset3sz&Annotation.xycoords..is_offsetz'xycoords cannot be an offset coordinate)rranymaprr|)rTrUr~rrrrU1s cCs|S)zQ The text position. See also *xytext* in `.Annotation`. )rrSrrrxyann;szAnnotation.xyanncCs||dSr)r4)rTrzrrrrDscCs|jS)z} Return the coordinate system to use for `.Annotation.xyann`. See also *xycoords* in `.Annotation`. rvrSrrr get_anncoordsHszAnnotation.get_anncoordscCs ||_dS)zz Set the coordinate system to use for `.Annotation.xyann`. See also *xycoords* in `.Annotation`. Nr)rTZcoordsrrr set_anncoordsPszAnnotation.set_anncoordsz> The coordinate system to use for `.Annotation.xyann`.)doccCs&|jdur|j|t||dSr)ry set_figurer)rTZfigrrrr[s  zAnnotation.set_figurecs||\||||j|jdur0dSt||}|j}|d| }|j |d|vr|dd}|dd}|dd }|d d}|durt d |d d } t| |||||d } |j jdi| |jdf|j|jddf|jdfg} |jdf|j|jddf|jdfg} t| fddd\} }t| fddd\}}||f|_t|| }|||d}||j _|j _|j\}}|j|j|}|j|j|}|j ||ffd|vr|j |dn|jr|j |jnl| dkr6|j ddS|d}t!|j|d|j|df|j||j|t"dd}|j |dS)zX Update the pixel positions of the annotation text and the arrow patch. NZmutation_scalernrrrrrrp rszh'frac' option in 'arrowprops' is no longer supported; use 'headlength' to set the head length in points.rq)Z head_lengthZ head_widthZ tail_widthsimplerrrorcst|dSNrabsv)r~rrrz-Annotation.update_positions..)rcst|dSrrr)rrrrrZpatchArVF)r3rrr"r)r)#rgrrY anncoordsrwrLr|rrvrryrrrurZset_arrowstyler}r~rrr$rxrhypotrZshrinkAZshrinkBrrZ set_positionsZ set_patchArirr r)rTr'rtr,msrrrrprsrqZstylekwZxposZyposr/Zrelposxr0ZrelposyrZ shrink_ptsr}rrr)r~rrupdate_positionsas`          &&     zAnnotation.update_positionscCs~|dur||_|r ||s$dS|||||jdurn|jjdurb|jdurb|j|j_|j|t||dSr) rjr{rhrrryrrrLrdrrrrs     zAnnotation.drawcCs|r||stS|dur(||_|jdur<|jj|_|jdurNtd||jt |}|g}|j dur| |j t |S)Nr)r{rhrrrjrrrrrLr|ryrunion)rTr'Z text_bboxZbboxesrrrr|s      zAnnotation.get_window_extentcs||stSt|Sr)rhrnullrZ get_tightbboxrdrrrrrs zAnnotation.get_tightbbox)NrTNNN)N)r@rArBrCrmr[rpropertyrUsetterrrrrrrrrErr|rrGrrrrrrl=s6 U     K  rl)rl)*rCloggingrrZnumpyrZ matplotlibr^rVrrrrrZ font_managerrZpatchesr r r textpathr Z transformsr rrrrr getLoggerr@rrr7ZinterpdZ_define_aliasesrLrHrSrlrmr[rrrrs^     'ESE#