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
<spanid="matplotlib-offsetbox"></span><h1><codeclass="docutils literal notranslate"><spanclass="pre">matplotlib.offsetbox</span></code><aclass="headerlink" href="#module-matplotlib.offsetbox" title="Permalink to this headline">¶</a></h1>
<p>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> is a simple container artist. Its child artists are
meant to be drawn at a relative position to OffsetBox. The [VH]Packer,
DrawingArea and TextArea are derived from the OffsetBox.</p>
<p>The [VH]Packer automatically adjust the relative positions of their
children, which should be instances of the OffsetBox. This is used to
align similar artists together, e.g., in legend.</p>
<p>The DrawingArea can contain any Artist as a child. The
DrawingArea has a fixed width and height. The position of children
relative to the parent is fixed. The TextArea is contains a single
Text instance. The width and height of the TextArea instance is the
width and height of the its child text.</p>
<dlclass="py class">
<dtid="matplotlib.offsetbox.AnchoredOffsetbox">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">AnchoredOffsetbox</code><spanclass="sig-paren">(</span><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">child</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <em><spanclass="n">prop</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <em><spanclass="n">frameon</span><spanclass="o">=</span><spanclass="default_value">True</span></em>, <em><spanclass="n">bbox_to_anchor</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <em><spanclass="n">bbox_transform</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#AnchoredOffsetbox"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.AnchoredOffsetbox" title="Permalink to this definition">¶</a></dt>
<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>
<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 legend will be anchored</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 artist. The extent of the child
<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>
<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 child will be anchored.</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, optional</span></dt><dd><p>Pad between the text and the frame as fraction of the font
size.</p>
</dd>
<dt><strong>borderpad</strong><spanclass="classifier">float, optional</span></dt><dd><p>Pad between the frame and the axes (or <em>bbox_to_anchor</em>).</p>
</dd>
<dt><strong>prop</strong><spanclass="classifier">dictionary, optional, default: None</span></dt><dd><p>Dictionary of keyword parameters to be passed to the
<p>Other keyword parameters of <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> are also
<p>Annotation-like class, but with offsetbox instead of Text.</p>
<p><em>offsetbox</em> : OffsetBox instance</p>
<dlclass="docutils">
<dt><em>xycoords</em><spanclass="classifier">same as Annotation but can be a tuple of two</span></dt><dd>strings which are interpreted as x and y coordinates.</dd>
<dt><em>boxcoords</em><spanclass="classifier">similar to textcoords as Annotation but can be a</span></dt><dd>tuple of two strings which are interpreted as x and y
coordinates.</dd>
<dt><em>box_alignment</em><spanclass="classifier">a tuple of two floats for a vertical and</span></dt><dd>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).</dd>
</dl>
<p>other parameters are identical to that of Annotation.</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>
<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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Annotation</span></code> object to the given <em>renderer</em>.</p>
<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><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.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">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>
<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 any <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-class 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>
<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>
<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>
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>
<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>
<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 any <aclass="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><codeclass="xref py py-class 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>
<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 with, 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>
<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> need to given in points and will be scale with
the renderer dpi, while <em>width</em> and <em>height</em> need to be in
<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. The child artist are meant
to be drawn at a relative position to its parent.</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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><dlclass="first last docutils">
<dt><strong>xy</strong><spanclass="classifier">(float, float) or callable</span></dt><dd><p>The (x, y) coordinates of the offset in display units. These can
either be given explicitly as a tuple (x, y), or by providing a
function that converts the extent into the offset. This function
<codeclass="descname">set_width</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">width</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetBox.set_width"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetBox.set_width" title="Permalink to this definition">¶</a></dt>
<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#OffsetImage.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage.draw" 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#OffsetImage.get_children"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage.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_data</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.get_data"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_data" 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#OffsetImage.get_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage.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#OffsetImage.get_offset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_offset" 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#OffsetImage.get_window_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_window_extent" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_zoom</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.get_zoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage.get_zoom" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_data</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">arr</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.set_data"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage.set_data" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_zoom</code><spanclass="sig-paren">(</span><em><spanclass="n">self</span></em>, <em><spanclass="n">zoom</span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage.set_zoom"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage.set_zoom" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="matplotlib.offsetbox.PackerBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">PackerBase</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">None</span></em>, <em><spanclass="n">mode</span><spanclass="o">=</span><spanclass="default_value">None</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#PackerBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.PackerBase" 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>