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.0.3). For the latest version see <ahref="https://matplotlib.org/stable/api/offsetbox_api.html">https://matplotlib.org/stable/api/offsetbox_api.html</a></div>
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>renderer</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><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><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><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>renderer</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>renderer</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>bbox</em>, <em>transform=None</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>child</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>bbox</em>, <em>fontsize=None</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="class">
<dtid="matplotlib.offsetbox.AnchoredText">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">AnchoredText</code><spanclass="sig-paren">(</span><em>s</em>, <em>loc</em>, <em>pad=0.4</em>, <em>borderpad=0.5</em>, <em>prop=None</em>, <em>**kwargs</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>
<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
<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>event</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>
<p>Returns the truth value and a dictionary of artist specific details of
selection, such as which points are contained in the pick radius. See
individual artists for details.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.offsetbox.AnnotationBbox.draw">
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>renderer</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><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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Artist`s</span><spanclass="pre">this</span>
<codeclass="descname">get_fontsize</code><spanclass="sig-paren">(</span><em>s=None</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>fig</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>s=None</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>renderer</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>
<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="class">
<dtid="matplotlib.offsetbox.AuxTransformBox">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">AuxTransformBox</code><spanclass="sig-paren">(</span><em>aux_transform</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>a</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>renderer</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>renderer</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 with, height, xdescent, ydescent of box</p>
<codeclass="descname">get_offset</code><spanclass="sig-paren">(</span><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><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>renderer</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>xy</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>t</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="class">
<dtid="matplotlib.offsetbox.DraggableAnnotation">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">DraggableAnnotation</code><spanclass="sig-paren">(</span><em>annotation</em>, <em>use_blit=False</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><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>dx</em>, <em>dy</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="class">
<dtid="matplotlib.offsetbox.DraggableBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">DraggableBase</code><spanclass="sig-paren">(</span><em>ref_artist</em>, <em>use_blit=False</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>
<codeclass="descname">artist_picker</code><spanclass="sig-paren">(</span><em>artist</em>, <em>evt</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><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><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>evt</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>evt</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>evt</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>event</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><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>dx</em>, <em>dy</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="class">
<dtid="matplotlib.offsetbox.DraggableOffsetBox">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">DraggableOffsetBox</code><spanclass="sig-paren">(</span><em>ref_artist</em>, <em>offsetbox</em>, <em>use_blit=False</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><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><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>dx</em>, <em>dy</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="class">
<dtid="matplotlib.offsetbox.DrawingArea">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">DrawingArea</code><spanclass="sig-paren">(</span><em>width</em>, <em>height</em>, <em>xdescent=0.0</em>, <em>ydescent=0.0</em>, <em>clip=False</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>a</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>
<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="method">
<dtid="matplotlib.offsetbox.DrawingArea.draw">
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>renderer</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>renderer</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><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><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>
<codeclass="descname">get_window_extent</code><spanclass="sig-paren">(</span><em>renderer</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>xy</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>t</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="class">
<dtid="matplotlib.offsetbox.HPacker">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">HPacker</code><spanclass="sig-paren">(</span><em>pad=None</em>, <em>sep=None</em>, <em>width=None</em>, <em>height=None</em>, <em>align='baseline'</em>, <em>mode='fixed'</em>, <em>children=None</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>
<codeclass="descname">get_extent_offsets</code><spanclass="sig-paren">(</span><em>renderer</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 children and return the extents of the box</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.offsetbox.OffsetBox">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">OffsetBox</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</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="attribute">
<dtid="matplotlib.offsetbox.OffsetBox.axes">
<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-class docutils literal notranslate"><spanclass="pre">Axes</span></code></a> instance the artist
resides in, or <em>None</em>.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.offsetbox.OffsetBox.contains">
<codeclass="descname">contains</code><spanclass="sig-paren">(</span><em>mouseevent</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>Test whether the artist contains the mouse event.</p>
<p>Returns the truth value and a dictionary of artist specific details of
selection, such as which points are contained in the pick radius. See
individual artists for details.</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.offsetbox.OffsetBox.draw">
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>renderer</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><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>
<codeclass="descname">get_extent</code><spanclass="sig-paren">(</span><em>renderer</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 with, height, xdescent, ydescent of box</p>
<codeclass="descname">get_extent_offsets</code><spanclass="sig-paren">(</span><em>renderer</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>
<codeclass="descname">get_visible_children</code><spanclass="sig-paren">(</span><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 visible artists it contains.</p>
<codeclass="descname">get_window_extent</code><spanclass="sig-paren">(</span><em>renderer</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>
<codeclass="descname">set_figure</code><spanclass="sig-paren">(</span><em>fig</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>
<codeclass="descname">set_height</code><spanclass="sig-paren">(</span><em>height</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>xy</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>
<codeclass="descname">set_width</code><spanclass="sig-paren">(</span><em>width</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>
<dd><p>Set the width</p>
<p>accepts float</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.offsetbox.OffsetImage">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">OffsetImage</code><spanclass="sig-paren">(</span><em>arr</em>, <em>zoom=1</em>, <em>cmap=None</em>, <em>norm=None</em>, <em>interpolation=None</em>, <em>origin=None</em>, <em>filternorm=1</em>, <em>filterrad=4.0</em>, <em>resample=False</em>, <em>dpi_cor=True</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#OffsetImage"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.OffsetImage" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>renderer</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><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>
<codeclass="descname">get_data</code><spanclass="sig-paren">(</span><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>renderer</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 with, height, xdescent, ydescent of box</p>
<codeclass="descname">get_offset</code><spanclass="sig-paren">(</span><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>renderer</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><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>arr</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>zoom</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="class">
<dtid="matplotlib.offsetbox.PackerBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">PackerBase</code><spanclass="sig-paren">(</span><em>pad=None</em>, <em>sep=None</em>, <em>width=None</em>, <em>height=None</em>, <em>align=None</em>, <em>mode=None</em>, <em>children=None</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>
<dd><pclass="first last">Alignment of boxes. Can be one of <codeclass="docutils literal notranslate"><spanclass="pre">top</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">bottom</span></code>,
<pclass="last"><em>pad</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 pixels.</p>
</div>
<dlclass="method">
<dtid="matplotlib.offsetbox.PaddedBox.draw">
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#PaddedBox.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.PaddedBox.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the location of children if necessary and draw them
<codeclass="descname">draw_frame</code><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#PaddedBox.draw_frame"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.PaddedBox.draw_frame" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_extent_offsets</code><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#PaddedBox.get_extent_offsets"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.PaddedBox.get_extent_offsets" title="Permalink to this definition">¶</a></dt>
<dd><p>update offset of childrens and return the extents of the box</p>
<codeclass="descname">update_frame</code><spanclass="sig-paren">(</span><em>bbox</em>, <em>fontsize=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#PaddedBox.update_frame"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.PaddedBox.update_frame" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.offsetbox.TextArea">
<emclass="property">class </em><codeclass="descclassname">matplotlib.offsetbox.</code><codeclass="descname">TextArea</code><spanclass="sig-paren">(</span><em>s</em>, <em>textprops=None</em>, <em>multilinebaseline=None</em>, <em>minimumdescent=True</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.TextArea" title="Permalink to this definition">¶</a></dt>
<dd><pclass="first last">If <aclass="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.7)"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">True</span></code></a>, baseline for multiline text is adjusted so that
it is (approximatedly) center-aligned with singleline
<dd><pclass="first last">If <aclass="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.7)"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">True</span></code></a>, the box has a minimum descent of "p".</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dlclass="method">
<dtid="matplotlib.offsetbox.TextArea.draw">
<codeclass="descname">draw</code><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea.draw"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.TextArea.draw" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw the children</p>
</dd></dl>
<dlclass="method">
<dtid="matplotlib.offsetbox.TextArea.get_extent">
<codeclass="descname">get_extent</code><spanclass="sig-paren">(</span><em>renderer</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea.get_extent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.TextArea.get_extent" title="Permalink to this definition">¶</a></dt>
<dd><p>Return with, height, xdescent, ydescent of box</p>
<codeclass="descname">get_minimumdescent</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea.get_minimumdescent"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.TextArea.get_minimumdescent" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_multilinebaseline</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/offsetbox.html#TextArea.get_multilinebaseline"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.offsetbox.TextArea.get_multilinebaseline" title="Permalink to this definition">¶</a></dt>