You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
<divid="unreleased-message"> You are reading an old version of the documentation (v3.4.0). For the latest version see <ahref="/stable/">https://matplotlib.org/stable/</a></div>
<spanclass="s2"> The number of columns that the legend has.</span>
<spanclass="s2">prop : None or `matplotlib.font_manager.FontProperties` or dict</span>
<spanclass="s2"> The font properties of the legend. If None (default), the current</span>
<spanclass="s2"> :data:`matplotlib.rcParams` will be used.</span>
<spanclass="s2">fontsize : int or {'xx-small', 'x-small', 'small', 'medium', 'large', </span><spanclass="se">\</span>
<spanclass="s2"> If *mode* is set to ``"expand"`` the legend will be horizontally</span>
<spanclass="s2"> expanded to fill the axes area (or *bbox_to_anchor* if defines</span>
<spanclass="s2"> the legend's size).</span>
<spanclass="s2">bbox_transform : None or `matplotlib.transforms.Transform`</span>
<spanclass="s2"> The transform for the bounding box (*bbox_to_anchor*). For a value</span>
<spanclass="s2"> of ``None`` (default) the Axes'</span>
<spanclass="s2"> :data:`~matplotlib.axes.Axes.transAxes` transform will be used.</span>
<spanclass="s2">title : str or None</span>
<spanclass="s2"> The legend's title. Default is no title (``None``).</span>
<spanclass="s2">title_fontsize : int or {'xx-small', 'x-small', 'small', 'medium', 'large', </span><spanclass="se">\</span>
<spanclass="sd"> Place a legend on the axes at location loc.</span>
<spanclass="sd"> """</span>
<spanclass="n">codes</span><spanclass="o">=</span><spanclass="p">{</span><spanclass="s1">'best'</span><spanclass="p">:</span><spanclass="mi">0</span><spanclass="p">,</span><spanclass="c1"># only implemented for axes legends</span>
<spanclass="n">numpoints</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># the number of points in the legend line</span>
<spanclass="n">markerscale</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># the relative size of legend markers</span>
<spanclass="n">scatterpoints</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># number of scatter points</span>
<spanclass="n">prop</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># properties for the legend texts</span>
<spanclass="n">fontsize</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># keyword to set font size directly</span>
<spanclass="n">labelcolor</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># keyword to set the text color</span>
<spanclass="c1"># spacing & pad defined as a fraction of the font-size</span>
<spanclass="n">borderpad</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># the whitespace inside the legend border</span>
<spanclass="n">labelspacing</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># the vertical space between the legend</span>
<spanclass="c1"># entries</span>
<spanclass="n">handlelength</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># the length of the legend handles</span>
<spanclass="n">handleheight</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># the height of the legend handles</span>
<spanclass="n">handletextpad</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># the pad between the legend handle</span>
<spanclass="c1"># and text</span>
<spanclass="n">borderaxespad</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># the pad between the axes and legend</span>
<spanclass="c1"># border</span>
<spanclass="n">columnspacing</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># spacing between columns</span>
<spanclass="n">ncol</span><spanclass="o">=</span><spanclass="mi">1</span><spanclass="p">,</span><spanclass="c1"># number of columns</span>
<spanclass="n">mode</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># mode for horizontal distribution of columns.</span>
<spanclass="c1"># None, "expand"</span>
<spanclass="n">fancybox</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># True use a fancy box, false use a rounded</span>
<spanclass="n">title</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># set a title for the legend</span>
<spanclass="n">title_fontsize</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># the font size for the title</span>
<spanclass="n">framealpha</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># set frame alpha</span>
<spanclass="n">bbox_to_anchor</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># bbox that the legend will be anchored.</span>
<spanclass="n">bbox_transform</span><spanclass="o">=</span><spanclass="kc">None</span><spanclass="p">,</span><spanclass="c1"># transform for the bbox</span>
<spanclass="n">_api</span><spanclass="o">.</span><spanclass="n">warn_external</span><spanclass="p">(</span><spanclass="s1">'The handle </span><spanclass="si">{!r}</span><spanclass="s1"> has a label of </span><spanclass="si">{!r}</span><spanclass="s1"> '</span>
<spanclass="s1">'which cannot be automatically added to'</span>
<spanclass="s1">' the legend.'</span><spanclass="o">.</span><spanclass="n">format</span><spanclass="p">(</span><spanclass="n">handle</span><spanclass="p">,</span><spanclass="n">label</span><spanclass="p">))</span>
<spanclass="k">raise</span><spanclass="ne">ValueError</span><spanclass="p">(</span><spanclass="s2">"numpoints must be > 0; it was </span><spanclass="si">%d</span><spanclass="s2">"</span><spanclass="o">%</span><spanclass="n">numpoints</span><spanclass="p">)</span>
<spanclass="c1"># introduce y-offset for handles of the scatter plot</span>
<spanclass="k">raise</span><spanclass="ne">TypeError</span><spanclass="p">(</span><spanclass="s2">"Legend needs either Axes or Figure as parent"</span><spanclass="p">)</span>
<spanclass="k">except</span><spanclass="p">(</span><spanclass="ne">TypeError</span><spanclass="p">,</span><spanclass="ne">KeyError</span><spanclass="p">):</span><spanclass="c1"># TypeError if unhashable.</span>
<spanclass="s2">"Legend does not support </span><spanclass="si">{!r}</span><spanclass="s2"> instances.</span><spanclass="se">\n</span><spanclass="s2">A proxy artist "</span>
<spanclass="s2">"may be used instead.</span><spanclass="se">\n</span><spanclass="s2">See: "</span>
<spanclass="sd"> Return display coordinates for hit testing for "best" positioning.</span>
<spanclass="sd"> Returns</span>
<spanclass="sd"> -------</span>
<spanclass="sd"> bboxes</span>
<spanclass="sd"> List of bounding boxes of all patches.</span>
<spanclass="sd"> lines</span>
<spanclass="sd"> List of `.Path` corresponding to each line.</span>
<spanclass="sd"> offsets</span>
<spanclass="sd"> List of (x, y) offsets of all collection.</span>
<spanclass="sd"> """</span>
<spanclass="k">assert</span><spanclass="bp">self</span><spanclass="o">.</span><spanclass="n">isaxes</span><spanclass="c1"># always holds, as this is only called internally</span>