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.3.2). For the latest version see <ahref="https://matplotlib.org/stable/api/offsetbox_api.html">https://matplotlib.org/stable/api/offsetbox_api.html</a></div>
<h1><codeclass="docutils literal notranslate"><spanclass="pre">matplotlib.offsetbox</span></code><aclass="headerlink" href="#matplotlib-offsetbox" title="Permalink to this headline">¶</a></h1>
<divclass="graphviz"><imgsrc="../_images/inheritance-36e5e0a74a56f39725340df3247c8da57f5ddeff.png" alt="Inheritance diagram of matplotlib.offsetbox" usemap="#inheritance11408564de" class="inheritance graphviz" /></div>
<areashape="rect" id="node1" href="#matplotlib.offsetbox.AnchoredOffsetbox" target="_top" title="An offset box placed according to location *loc*." alt="" coords="419,4,596,31"/>
<areashape="rect" id="node3" href="#matplotlib.offsetbox.AnchoredText" target="_top" title="AnchoredOffsetbox with Text." alt="" coords="633,4,764,31"/>
<areashape="rect" id="node2" href="#matplotlib.offsetbox.OffsetBox" target="_top" title="The OffsetBox is a simple container artist." alt="" coords="235,141,333,168"/>
<areashape="rect" id="node6" href="#matplotlib.offsetbox.AuxTransformBox" target="_top" title="Offset Box with the aux_transform. Its children will be" alt="" coords="426,50,589,77"/>
<areashape="rect" id="node10" href="#matplotlib.offsetbox.DrawingArea" target="_top" title="The DrawingArea can contain any Artist as a child. The DrawingArea" alt="" coords="446,95,570,122"/>
<areashape="rect" id="node14" href="#matplotlib.offsetbox.PaddedBox" target="_top" title="A container to add a padding around an `.Artist`." alt="" coords="452,232,563,259"/>
<areashape="rect" id="node15" href="#matplotlib.offsetbox.TextArea" target="_top" title="The TextArea is contains a single Text instance. The text is" alt="" coords="463,277,552,304"/>
<areashape="rect" id="node4" href="#matplotlib.offsetbox.AnnotationBbox" target="_top" title="Container for an `OffsetBox` referring to a specific position *xy*." alt="" coords="209,186,360,213"/>
<areashape="rect" id="node5" href="artist_api.html#matplotlib.artist.Artist" target="_top" title="Abstract base class for objects that render into a FigureCanvas." alt="" coords="46,164,107,190"/>
<areashape="rect" id="node8" href="#matplotlib.offsetbox.DraggableBase" target="_top" title="Helper base class for a draggable artist (legend, offsetbox)." alt="" coords="4,72,149,99"/>
<areashape="rect" id="node11" href="#matplotlib.offsetbox.HPacker" target="_top" title="The HPacker has its children packed horizontally. It automatically" alt="" coords="656,118,741,145"/>
<areashape="rect" id="node16" href="#matplotlib.offsetbox.VPacker" target="_top" title="The VPacker has its children packed vertically. It automatically" alt="" coords="657,164,741,190"/>
<dt><aclass="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">OffsetBox</span></code></a></dt><dd>The base of all container artists defined in this module.</dd>
<dt><aclass="reference internal" href="#matplotlib.offsetbox.AnchoredOffsetbox" title="matplotlib.offsetbox.AnchoredOffsetbox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">AnchoredOffsetbox</span></code></a>, <aclass="reference internal" href="#matplotlib.offsetbox.AnchoredText" title="matplotlib.offsetbox.AnchoredText"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">AnchoredText</span></code></a></dt><dd>Anchor and align an arbitrary <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a> or a text relative to the parent
axes or a specific anchor point.</dd>
<dt><aclass="reference internal" href="#matplotlib.offsetbox.DrawingArea" title="matplotlib.offsetbox.DrawingArea"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">DrawingArea</span></code></a></dt><dd>A container with fixed width and height. Children have a fixed position
inside the container and may be clipped.</dd>
<dt><aclass="reference internal" href="#matplotlib.offsetbox.HPacker" title="matplotlib.offsetbox.HPacker"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">HPacker</span></code></a>, <aclass="reference internal" href="#matplotlib.offsetbox.VPacker" title="matplotlib.offsetbox.VPacker"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">VPacker</span></code></a></dt><dd>Containers for layouting their children vertically or horizontally.</dd>
<dt><aclass="reference internal" href="#matplotlib.offsetbox.PaddedBox" title="matplotlib.offsetbox.PaddedBox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">PaddedBox</span></code></a></dt><dd>A container to add a padding around an <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a>.</dd>
<p>For backward compatibility, numeric values are accepted as well.
See the parameter <em>loc</em> of <aclass="reference internal" href="legend_api.html#matplotlib.legend.Legend" title="matplotlib.legend.Legend"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Legend</span></code></a> for details.</p>
</dd>
<dt><strong>pad</strong><spanclass="classifier">float, default: 0.4</span></dt><dd><p>Padding around the child as fraction of the fontsize.</p>
</dd>
<dt><strong>borderpad</strong><spanclass="classifier">float, default: 0.5</span></dt><dd><p>Padding between the offsetbox frame and the <em>bbox_to_anchor</em>.</p>
</dd>
<dt><strong>child</strong><spanclass="classifier"><aclass="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">OffsetBox</span></code></a></span></dt><dd><p>The box that will be anchored.</p>
</dd>
<dt><strong>prop</strong><spanclass="classifier"><aclass="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">FontProperties</span></code></a></span></dt><dd><p>This is only used as a reference for paddings. If not given,
<dt><strong>frameon</strong><spanclass="classifier">bool</span></dt><dd><p>Whether to draw a frame around the box.</p>
</dd>
<dt><strong>bbox_to_anchor</strong><spanclass="classifier"><aclass="reference internal" href="transformations.html#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">BboxBase</span></code></a>, 2-tuple, or 4-tuple of floats</span></dt><dd><p>Box that is used to position the legend in conjunction with <em>loc</em>.</p>
</dd>
<dt><strong>bbox_transform</strong><spanclass="classifier">None or <aclass="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">matplotlib.transforms.Transform</span></code></a></span></dt><dd><p>The transform for the bounding box (<em>bbox_to_anchor</em>).</p>
</dd>
<dt><strong>**kwargs</strong></dt><dd><p>All other parameters are passed on to <aclass="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">OffsetBox</span></code></a>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p>See <aclass="reference internal" href="legend_api.html#matplotlib.legend.Legend" title="matplotlib.legend.Legend"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Legend</span></code></a> for a detailed description of the anchoring mechanism.</p>
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the location of children if necessary and draw them
<codeclass="descname">get_bbox_to_anchor</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_bbox_to_anchor"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_bbox_to_anchor" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the bbox that the box is anchored to.</p>
<codeclass="descname">get_child</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_child"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_child" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_children</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_children"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_children" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_extent</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the extent of the box as (width, height, x, y).</p>
<p>This is the extent of the child plus the padding.</p>
<codeclass="descname">get_window_extent</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.get_window_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the bounding box in display space.</p>
<codeclass="descname">set_bbox_to_anchor</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">bbox</span></em>, <em><spanclass="n">transform</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.set_bbox_to_anchor"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.set_bbox_to_anchor" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the bbox that the box is anchored to.</p>
<p><em>bbox</em> can be a Bbox instance, a list of [left, bottom, width,
height], or a list of [left, bottom] where the width and
height will be assumed to be zero. The bbox will be
transformed to display coordinate by the given transform.</p>
<codeclass="descname">set_child</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">child</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.set_child"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.set_child" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">update_frame</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">bbox</span></em>, <em><spanclass="n">fontsize</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredOffsetbox.update_frame"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.update_frame" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">zorder</code><emclass="property"> = 5</em><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox.zorder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.offsetbox.AnchoredText">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">AnchoredText</code><spanclass="sig-paren">(</span><em><spanclass="n">s</span></em>, <em><spanclass="n">loc</span></em>, <em><spanclass="n">pad</span><spanclass="o">=</span><spanclass="default_value">0.4</span></em>, <em><spanclass="n">borderpad</span><spanclass="o">=</span><spanclass="default_value">0.5</span></em>, <em><spanclass="n">prop</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnchoredText"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredText" title="Permalink to this definition">¶</a></dt>
<dt><strong>pad</strong><spanclass="classifier">float, default: 0.4</span></dt><dd><p>Padding around the text as fraction of the fontsize.</p>
</dd>
<dt><strong>borderpad</strong><spanclass="classifier">float, default: 0.5</span></dt><dd><p>Spacing between the offsetbox frame and the <em>bbox_to_anchor</em>.</p>
</dd>
<dt><strong>prop</strong><spanclass="classifier">dict, optional</span></dt><dd><p>Dictionary of keyword parameters to be passed to the
<dt><strong>**kwargs</strong></dt><dd><p>All other parameters are passed to <aclass="reference internal" href="#matplotlib.offsetbox.AnchoredOffsetbox" title="matplotlib.offsetbox.AnchoredOffsetbox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">AnchoredOffsetbox</span></code></a>.</p>
<p>Container for an <aclass="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">OffsetBox</span></code></a> referring to a specific position <em>xy</em>.</p>
<p>Optionally an arrow pointing from the offsetbox to <em>xy</em> can be drawn.</p>
<p>This is like <aclass="reference internal" href="text_api.html#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Annotation</span></code></a>, but with <aclass="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">OffsetBox</span></code></a> instead of <aclass="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Text</span></code></a>.</p>
<dt><strong>xy</strong><spanclass="classifier">(float, float)</span></dt><dd><p>The point <em>(x, y)</em> to annotate. The coordinate system is determined
by <em>xycoords</em>.</p>
</dd>
<dt><strong>xybox</strong><spanclass="classifier">(float, float), default: <em>xy</em></span></dt><dd><p>The position <em>(x, y)</em> to place the text at. The coordinate system
is determined by <em>boxcoords</em>.</p>
</dd>
<dt><strong>xycoords</strong><spanclass="classifier">str or <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a> or <aclass="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Transform</span></code></a> or callable or (float, float), default: 'data'</span></dt><dd><p>The coordinate system that <em>xy</em> is given in. See the parameter
<em>xycoords</em> in <aclass="reference internal" href="text_api.html#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Annotation</span></code></a> for a detailed description.</p>
</dd>
<dt><strong>boxcoords</strong><spanclass="classifier">str or <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a> or <aclass="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Transform</span></code></a> or callable or (float, float), default: value of <em>xycoords</em></span></dt><dd><p>The coordinate system that <em>xybox</em> is given in. See the parameter
<em>textcoords</em> in <aclass="reference internal" href="text_api.html#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Annotation</span></code></a> for a detailed description.</p>
</dd>
<dt><strong>frameon</strong><spanclass="classifier">bool, default: True</span></dt><dd><p>Whether to draw a frame around the box.</p>
</dd>
<dt><strong>pad</strong><spanclass="classifier">float, default: 0.4</span></dt><dd><p>Padding around the offsetbox.</p>
</dd>
<dt><strong>box_alignment</strong><spanclass="classifier">(float, float)</span></dt><dd><p>A tuple of two floats for a vertical and horizontal alignment of
the offset box w.r.t. the <em>boxcoords</em>.
The lower-left corner is (0, 0) and upper-right corner is (1, 1).</p>
</dd>
<dt><strong>**kwargs</strong></dt><dd><p>Other parameters are identical to <aclass="reference internal" href="text_api.html#matplotlib.text.Annotation" title="matplotlib.text.Annotation"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Annotation</span></code></a>.</p>
<emclass="property">property </em><codeclass="descname">anncoords</code><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.anncoords" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">contains</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">mouseevent</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.contains"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Test whether the artist contains the mouse event.</p>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>contains</strong><spanclass="classifier">bool</span></dt><dd><p>Whether any values are within the radius.</p>
</dd>
<dt><strong>details</strong><spanclass="classifier">dict</span></dt><dd><p>An artist-specific dictionary of details of the event context,
such as which points are contained in the pick radius. See the
individual Artist subclasses for details.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="py method">
<dtid="matplotlib.offsetbox.AnnotationBbox.draw">
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the Artist (and its children) using the given renderer.</p>
<p>This has no effect if the artist is not visible (<aclass="reference internal" href="_as_gen/matplotlib.artist.Artist.get_visible.html#matplotlib.artist.Artist.get_visible" title="matplotlib.artist.Artist.get_visible"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist.get_visible</span></code></a>
<codeclass="descname">get_children</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.get_children"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the child <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a>s of this <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a>.</p>
<codeclass="descname">get_fontsize</code><spanclass="sig-paren">(</span><em>self</em>, <em>s=<deprecated parameter></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.get_fontsize"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.get_fontsize" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_tightbbox</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.get_tightbbox"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.get_tightbbox" title="Permalink to this definition">¶</a></dt>
<dd><p>get tight bounding box in display space.</p>
<codeclass="descname">get_window_extent</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.get_window_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.get_window_extent" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_figure</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">fig</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.set_figure"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <aclass="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Figure</span></code></a> instance the artist belongs to.</p>
<codeclass="descname">set_fontsize</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">s</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.set_fontsize"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.set_fontsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the fontsize in points.</p>
<p>If <em>s</em> is not given, reset to <codeclass="docutils literal notranslate"><aclass="reference external" href="../tutorials/introductory/customizing.html?highlight=legend.fontsize#a-sample-matplotlibrc-file"><spanclass="pre">rcParams["legend.fontsize"]</span></a></code> (default: <codeclass="docutils literal notranslate"><spanclass="pre">'medium'</span></code>).</p>
<codeclass="descname">update_positions</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AnnotationBbox.update_positions"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.update_positions" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the pixel positions of the annotated point and the text.</p>
<emclass="property">property </em><codeclass="descname">xyann</code><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.xyann" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">zorder</code><emclass="property"> = 3</em><aclass="headerlink" href="#matplotlib.offsetbox.AnnotationBbox.zorder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.offsetbox.AuxTransformBox">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">AuxTransformBox</code><spanclass="sig-paren">(</span><em><spanclass="n">aux_transform</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AuxTransformBox" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">add_artist</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.add_artist"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.add_artist" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a> to the container box.</p>
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the location of children if necessary and draw them
<codeclass="descname">get_extent</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.get_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a tuple <codeclass="docutils literal notranslate"><spanclass="pre">width,</span><spanclass="pre">height,</span><spanclass="pre">xdescent,</span><spanclass="pre">ydescent</span></code> of the box.</p>
<codeclass="descname">get_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.get_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_offset" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_transform</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.get_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_transform" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_window_extent</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.get_window_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the bounding box in display space.</p>
<codeclass="descname">set_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">xy</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.set_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.set_offset" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_transform</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">t</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#AuxTransformBox.set_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AuxTransformBox.set_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>set_transform is ignored.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.offsetbox.DraggableAnnotation">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">DraggableAnnotation</code><spanclass="sig-paren">(</span><em><spanclass="n">annotation</span></em>, <em><spanclass="n">use_blit</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableAnnotation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">save_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableAnnotation.save_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation.save_offset" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">update_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">dx</span></em>, <em><spanclass="n">dy</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableAnnotation.update_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableAnnotation.update_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.offsetbox.DraggableBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">DraggableBase</code><spanclass="sig-paren">(</span><em><spanclass="n">ref_artist</span></em>, <em><spanclass="n">use_blit</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase" title="Permalink to this definition">¶</a></dt>
<spanclass="sd">'''Called when the mouse is released.'''</span>
</pre></div>
</div>
<p>In the current implementation of <aclass="reference internal" href="legend_api.html#matplotlib.legend.DraggableLegend" title="matplotlib.legend.DraggableLegend"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">DraggableLegend</span></code></a> and
coordinates, and <aclass="reference internal" href="#matplotlib.offsetbox.DraggableBase.finalize_offset" title="matplotlib.offsetbox.DraggableBase.finalize_offset"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">finalize_offset</span></code></a> recalculates their position in axes
<codeclass="descname">artist_picker</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">artist</span></em>, <em><spanclass="n">evt</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.artist_picker"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase.artist_picker" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<pclass="rubric">Notes</p>
<divclass="deprecated">
<p><spanclass="versionmodified deprecated">Deprecated since version 3.3: </span></p>
<codeclass="descname">disconnect</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.disconnect"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase.disconnect" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">finalize_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.finalize_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase.finalize_offset" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">on_motion</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">evt</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.on_motion"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_motion" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">on_motion_blit</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">evt</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.on_motion_blit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_motion_blit" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<pclass="rubric">Notes</p>
<divclass="deprecated">
<p><spanclass="versionmodified deprecated">Deprecated since version 3.3: </span></p>
<codeclass="descname">on_pick</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">evt</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.on_pick"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_pick" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">on_release</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">event</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.on_release"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase.on_release" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">save_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.save_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase.save_offset" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">update_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">dx</span></em>, <em><spanclass="n">dy</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableBase.update_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableBase.update_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.offsetbox.DraggableOffsetBox">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">DraggableOffsetBox</code><spanclass="sig-paren">(</span><em><spanclass="n">ref_artist</span></em>, <em><spanclass="n">offsetbox</span></em>, <em><spanclass="n">use_blit</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableOffsetBox"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_loc_in_canvas</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableOffsetBox.get_loc_in_canvas"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox.get_loc_in_canvas" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">save_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableOffsetBox.save_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox.save_offset" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">update_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">dx</span></em>, <em><spanclass="n">dy</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DraggableOffsetBox.update_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DraggableOffsetBox.update_offset" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.offsetbox.DrawingArea">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">DrawingArea</code><spanclass="sig-paren">(</span><em><spanclass="n">width</span></em>, <em><spanclass="n">height</span></em>, <em><spanclass="n">xdescent</span><spanclass="o">=</span><spanclass="default_value">0.0</span></em>, <em><spanclass="n">ydescent</span><spanclass="o">=</span><spanclass="default_value">0.0</span></em>, <em><spanclass="n">clip</span><spanclass="o">=</span><spanclass="default_value">False</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">add_artist</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">a</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.add_artist"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea.add_artist" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a> to the container box.</p>
<emclass="property">property </em><codeclass="descname">clip_children</code><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea.clip_children" title="Permalink to this definition">¶</a></dt>
<dd><p>If the children of this DrawingArea should be clipped
by DrawingArea bounding box.</p>
</dd></dl>
<dlclass="py method">
<dtid="matplotlib.offsetbox.DrawingArea.draw">
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the location of children if necessary and draw them
<codeclass="descname">get_extent</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.get_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return width, height, xdescent, ydescent of box.</p>
<codeclass="descname">get_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.get_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_offset" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_transform</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.get_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <aclass="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Transform</span></code></a> applied to the children.</p>
<codeclass="descname">get_window_extent</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.get_window_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the bounding box in display space.</p>
<codeclass="descname">set_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">xy</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.set_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea.set_offset" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_transform</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">t</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#DrawingArea.set_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.DrawingArea.set_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>set_transform is ignored.</p>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.offsetbox.HPacker">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">HPacker</code><spanclass="sig-paren">(</span><em><spanclass="n">pad</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <em><spanclass="n">sep</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <em><spanclass="n">width</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <em><spanclass="n">height</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <em><spanclass="n">align</span><spanclass="o">=</span><spanclass="default_value">'baseline'</span></em>, <em><spanclass="n">mode</span><spanclass="o">=</span><spanclass="default_value">'fixed'</span></em>, <em><spanclass="n">children</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#HPacker"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.HPacker" title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>pad</strong><spanclass="classifier">float, optional</span></dt><dd><p>The boundary padding in points.</p>
</dd>
<dt><strong>sep</strong><spanclass="classifier">float, optional</span></dt><dd><p>The spacing between items in points.</p>
</dd>
<dt><strong>width, height</strong><spanclass="classifier">float, optional</span></dt><dd><p>Width and height of the container box in pixels, calculated if
<em>None</em>.</p>
</dd>
<dt><strong>align</strong><spanclass="classifier">{'top', 'bottom', 'left', 'right', 'center', 'baseline'}</span></dt><dd><p>Alignment of boxes.</p>
<li>'fixed' packs the given <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artists</span></code> tight with <em>sep</em> spacing.</li>
<li>'expand' uses the maximal available space to distribute the
artists with equal spacing in between.</li>
<li>'equal': Each artist an equal fraction of the available space
and is left-aligned (or top-aligned) therein.</li>
</ul>
</dd>
<dt><strong>children</strong><spanclass="classifier">list of <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a></span></dt><dd><p>The artists to pack.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<pclass="rubric">Notes</p>
<p><em>pad</em> and <em>sep</em> are in points and will be scaled with the renderer
dpi, while <em>width</em> and <em>height</em> are in in pixels.</p>
<codeclass="descname">get_extent_offsets</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#HPacker.get_extent_offsets"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.HPacker.get_extent_offsets" title="Permalink to this definition">¶</a></dt>
<dd><p>Update offset of the children and return the extent of the box.</p>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><dlclass="first last docutils">
<dt>width</dt><dd></dd>
<dt>height</dt><dd></dd>
<dt>xdescent</dt><dd></dd>
<dt>ydescent</dt><dd></dd>
<dt>list of (xoffset, yoffset) pairs</dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.offsetbox.OffsetBox">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">OffsetBox</code><spanclass="sig-paren">(</span><em><spanclass="o">*</span><spanclass="n">args</span></em>, <em><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox" title="Permalink to this definition">¶</a></dt>
<p>The OffsetBox is a simple container artist.</p>
<p>The child artists are meant to be drawn at a relative position to its
parent.</p>
<p>Being an artist itself, all parameters are passed on to <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a>.</p>
<dlclass="py method">
<dtid="matplotlib.offsetbox.OffsetBox.axes">
<emclass="property">property </em><codeclass="descname">axes</code><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.axes" title="Permalink to this definition">¶</a></dt>
<dd><p>The <aclass="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Axes</span></code></a> instance the artist resides in, or <em>None</em>.</p>
</dd></dl>
<dlclass="py method">
<dtid="matplotlib.offsetbox.OffsetBox.contains">
<codeclass="descname">contains</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">mouseevent</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.contains"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.contains" title="Permalink to this definition">¶</a></dt>
<dd><p>Delegate the mouse event contains-check to the children.</p>
<p>As a container, the <aclass="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">OffsetBox</span></code></a> does not respond itself to
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the location of children if necessary and draw them
<codeclass="descname">get_children</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_children"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the child <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a>s.</p>
<codeclass="descname">get_extent</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a tuple <codeclass="docutils literal notranslate"><spanclass="pre">width,</span><spanclass="pre">height,</span><spanclass="pre">xdescent,</span><spanclass="pre">ydescent</span></code> of the box.</p>
<codeclass="descname">get_extent_offsets</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_extent_offsets"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_extent_offsets" title="Permalink to this definition">¶</a></dt>
<dd><p>Update offset of the children and return the extent of the box.</p>
<codeclass="descname">get_visible_children</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_visible_children"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_visible_children" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the visible child <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Artist</span></code></a>s.</p>
<codeclass="descname">get_window_extent</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">renderer</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.get_window_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.get_window_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the bounding box (<aclass="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Bbox</span></code></a>) in display space.</p>
<codeclass="descname">set_figure</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">fig</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.set_figure"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <aclass="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">Figure</span></code></a> for the <aclass="reference internal" href="#matplotlib.offsetbox.OffsetBox" title="matplotlib.offsetbox.OffsetBox"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">OffsetBox</span></code></a> and all its children.</p>
<codeclass="descname">set_height</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">height</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.set_height"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_height" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_offset</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">xy</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.set_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_offset" title="Permalink to this definition">¶</a></dt>