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 (v2.2.4). For the latest version see <ahref="https://matplotlib.org/stable/api/backend_tools_api.html">https://matplotlib.org/stable/api/backend_tools_api.html</a></div>
<spanid="matplotlib-backend-tools"></span><h1><aclass="reference internal" href="#module-matplotlib.backend_tools" title="matplotlib.backend_tools"><codeclass="xref py py-mod docutils literal notranslate"><spanclass="pre">matplotlib.backend_tools</span></code></a><aclass="headerlink" href="#module-matplotlib.backend_tools" title="Permalink to this headline">¶</a></h1>
<p>Abstract base classes define the primitives for Tools.
These tools are used by <aclass="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">matplotlib.backend_managers.ToolManager</span></code></a></p>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">AxisScaleBase</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#AxisScaleBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.AxisScaleBase" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">disable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#AxisScaleBase.disable"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.AxisScaleBase.disable" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable the toggle tool</p>
<p><aclass="reference internal" href="#matplotlib.backend_tools.AxisScaleBase.trigger" title="matplotlib.backend_tools.AxisScaleBase.trigger"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">trigger</span></code></a> call this method when <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">toggled</span></code> is True.</p>
<codeclass="descname">enable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#AxisScaleBase.enable"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.AxisScaleBase.enable" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable the toggle tool</p>
<p><aclass="reference internal" href="#matplotlib.backend_tools.AxisScaleBase.trigger" title="matplotlib.backend_tools.AxisScaleBase.trigger"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">trigger</span></code></a> calls this method when <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">toggled</span></code> is False</p>
<codeclass="descname">trigger</code><spanclass="sig-paren">(</span><em>sender</em>, <em>event</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#AxisScaleBase.trigger"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.AxisScaleBase.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Calls <aclass="reference internal" href="#matplotlib.backend_tools.AxisScaleBase.enable" title="matplotlib.backend_tools.AxisScaleBase.enable"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">enable</span></code></a> or <aclass="reference internal" href="#matplotlib.backend_tools.AxisScaleBase.disable" title="matplotlib.backend_tools.AxisScaleBase.disable"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">disable</span></code></a> based on <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">toggled</span></code> value</p>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ConfigureSubplotsBase</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ConfigureSubplotsBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ConfigureSubplotsBase" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Configure subplots'</em><aclass="headerlink" href="#matplotlib.backend_tools.ConfigureSubplotsBase.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">image</code><emclass="property"> = 'subplots'</em><aclass="headerlink" href="#matplotlib.backend_tools.ConfigureSubplotsBase.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.Cursors">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">Cursors</code><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#Cursors"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.Cursors" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">HAND</code><emclass="property"> = 0</em><aclass="headerlink" href="#matplotlib.backend_tools.Cursors.HAND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.Cursors.MOVE">
<codeclass="descname">MOVE</code><emclass="property"> = 3</em><aclass="headerlink" href="#matplotlib.backend_tools.Cursors.MOVE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.Cursors.POINTER">
<codeclass="descname">POINTER</code><emclass="property"> = 1</em><aclass="headerlink" href="#matplotlib.backend_tools.Cursors.POINTER" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SELECT_REGION</code><emclass="property"> = 2</em><aclass="headerlink" href="#matplotlib.backend_tools.Cursors.SELECT_REGION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.Cursors.WAIT">
<codeclass="descname">WAIT</code><emclass="property"> = 4</em><aclass="headerlink" href="#matplotlib.backend_tools.Cursors.WAIT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.RubberbandBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">RubberbandBase</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#RubberbandBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.RubberbandBase" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">draw_rubberband</code><spanclass="sig-paren">(</span><em>*data</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#RubberbandBase.draw_rubberband"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.RubberbandBase.draw_rubberband" title="Permalink to this definition">¶</a></dt>
<dd><p>Draw rubberband</p>
<p>This method must get implemented per backend</p>
<codeclass="descname">remove_rubberband</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#RubberbandBase.remove_rubberband"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.RubberbandBase.remove_rubberband" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove rubberband</p>
<p>This method should get implemented per backend</p>
<codeclass="descname">trigger</code><spanclass="sig-paren">(</span><em>sender</em>, <em>event</em>, <em>data</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#RubberbandBase.trigger"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.RubberbandBase.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Call <aclass="reference internal" href="#matplotlib.backend_tools.RubberbandBase.draw_rubberband" title="matplotlib.backend_tools.RubberbandBase.draw_rubberband"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">draw_rubberband</span></code></a> or <aclass="reference internal" href="#matplotlib.backend_tools.RubberbandBase.remove_rubberband" title="matplotlib.backend_tools.RubberbandBase.remove_rubberband"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">remove_rubberband</span></code></a> based on data</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.SaveFigureBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">SaveFigureBase</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#SaveFigureBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.SaveFigureBase" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['s', 'ctrl+s']</em><aclass="headerlink" href="#matplotlib.backend_tools.SaveFigureBase.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Save the figure'</em><aclass="headerlink" href="#matplotlib.backend_tools.SaveFigureBase.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">image</code><emclass="property"> = 'filesave'</em><aclass="headerlink" href="#matplotlib.backend_tools.SaveFigureBase.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.SetCursorBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">SetCursorBase</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#SetCursorBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.SetCursorBase" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_cursor</code><spanclass="sig-paren">(</span><em>cursor</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#SetCursorBase.set_cursor"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.SetCursorBase.set_cursor" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the cursor</p>
<p>This method has to be implemented per backend</p>
<codeclass="descname">set_figure</code><spanclass="sig-paren">(</span><em>figure</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#SetCursorBase.set_figure"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.SetCursorBase.set_figure" 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>figure: `Figure`</strong></dt>
<dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolBack">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolBack</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolBack"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolBack" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['left', 'c', 'backspace']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolBack.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Back to previous view'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolBack.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.ToolBack.image">
<codeclass="descname">image</code><emclass="property"> = 'back'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolBack.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolBase</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase" title="Permalink to this definition">¶</a></dt>
<p>A base tool, only implements <aclass="reference internal" href="#matplotlib.backend_tools.ToolBase.trigger" title="matplotlib.backend_tools.ToolBase.trigger"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">trigger</span></code></a> method or not method at all.
The tool is instantiated by <aclass="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager" title="matplotlib.backend_managers.ToolManager"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">matplotlib.backend_managers.ToolManager</span></code></a></p>
<dd><pclass="first last">ToolManager that controls this Tool</p>
</dd>
<dt><strong>figure: `FigureCanvas`</strong></dt>
<dd><pclass="first last">Figure instance that is affected by this Tool</p>
</dd>
<dt><strong>name: String</strong></dt>
<dd><pclass="first last">Used as <strong>Id</strong> of the tool, has to be unique among tools of the same
ToolManager</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.ToolBase.canvas">
<codeclass="descname">canvas</code><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.canvas" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = None</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.default_keymap" title="Permalink to this definition">¶</a></dt>
<dd><p>Keymap to associate with this tool</p>
<p><strong>String</strong>: List of comma separated keys that will be used to call this
tool when the keypress event of <em>self.figure.canvas</em> is emitted</p>
<codeclass="descname">description</code><emclass="property"> = None</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.description" title="Permalink to this definition">¶</a></dt>
<dd><p>Description of the Tool</p>
<p><strong>String</strong>: If the Tool is included in the Toolbar this text is used
<codeclass="descname">destroy</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolBase.destroy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.destroy" title="Permalink to this definition">¶</a></dt>
<dd><p>Destroy the tool</p>
<p>This method is called when the tool is removed by
<codeclass="descname">figure</code><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.figure" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.ToolBase.image">
<codeclass="descname">image</code><emclass="property"> = None</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.image" title="Permalink to this definition">¶</a></dt>
<dd><p>Filename of the image</p>
<p><strong>String</strong>: Filename of the image to use in the toolbar. If None, the
<aclass="reference internal" href="#matplotlib.backend_tools.ToolBase.name" title="matplotlib.backend_tools.ToolBase.name"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">name</span></code></a> is used as a label in the toolbar button</p>
</dd></dl>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.ToolBase.name">
<codeclass="descname">name</code><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.name" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_figure</code><spanclass="sig-paren">(</span><em>figure</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolBase.set_figure"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.set_figure" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">toolmanager</code><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.toolmanager" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">trigger</code><spanclass="sig-paren">(</span><em>sender</em>, <em>event</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolBase.trigger"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolBase.trigger" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolCursorPosition</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolCursorPosition"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolCursorPosition" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">send_message</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolCursorPosition.send_message"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolCursorPosition.send_message" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_figure</code><spanclass="sig-paren">(</span><em>figure</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolCursorPosition.set_figure"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolCursorPosition.set_figure" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolEnableAllNavigation</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolEnableAllNavigation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolEnableAllNavigation" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['a']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolEnableAllNavigation.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Enables all axes toolmanager'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolEnableAllNavigation.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">trigger</code><spanclass="sig-paren">(</span><em>sender</em>, <em>event</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolEnableAllNavigation.trigger"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolEnableAllNavigation.trigger" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolEnableNavigation</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolEnableNavigation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolEnableNavigation" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Enables one axes toolmanager'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolEnableNavigation.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">trigger</code><spanclass="sig-paren">(</span><em>sender</em>, <em>event</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolEnableNavigation.trigger"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolEnableNavigation.trigger" 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>event: `Event`</strong></dt>
<dd><pclass="first last">The Canvas event that caused this tool to be called</p>
</dd>
<dt><strong>sender: object</strong></dt>
<dd><pclass="first last">Object that requested the tool to be triggered</p>
</dd>
<dt><strong>data: object</strong></dt>
<dd><pclass="first last">Extra data</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolForward">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolForward</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolForward"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolForward" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['right', 'v']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolForward.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Forward to next view'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolForward.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">image</code><emclass="property"> = 'forward'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolForward.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolFullScreen">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolFullScreen</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolFullScreen"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolFullScreen" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['f', 'ctrl+f']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Toogle Fullscreen mode'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">disable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolFullScreen.disable"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.disable" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable the toggle tool</p>
<p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">trigger</span></code> call this method when <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">toggled</span></code> is True.</p>
<codeclass="descname">enable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolFullScreen.enable"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.enable" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable the toggle tool</p>
<p><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">trigger</span></code> calls this method when <codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">toggled</span></code> is False</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolGrid">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolGrid</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolGrid"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolGrid" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['g']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolGrid.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Toogle major grids'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolGrid.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolHome">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolHome</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolHome"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolHome" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['h', 'r', 'home']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolHome.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Reset original view'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolHome.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.ToolHome.image">
<codeclass="descname">image</code><emclass="property"> = 'home'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolHome.image" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolMinorGrid">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolMinorGrid</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolMinorGrid"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolMinorGrid" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['G']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolMinorGrid.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Toogle major and minor grids'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolMinorGrid.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolPan">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolPan</code><spanclass="sig-paren">(</span><em>*args</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolPan"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolPan" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">cursor</code><emclass="property"> = 3</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolPan.cursor" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['p']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolPan.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Pan axes with left mouse, zoom with right'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolPan.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.ToolPan.image">
<codeclass="descname">image</code><emclass="property"> = 'move'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolPan.image" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">radio_group</code><emclass="property"> = 'default'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolPan.radio_group" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolQuit">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolQuit</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolQuit"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolQuit" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['ctrl+w', 'cmd+w', 'q']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolQuit.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Quit the figure'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolQuit.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">trigger</code><spanclass="sig-paren">(</span><em>sender</em>, <em>event</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolQuit.trigger"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolQuit.trigger" 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>event: `Event`</strong></dt>
<dd><pclass="first last">The Canvas event that caused this tool to be called</p>
</dd>
<dt><strong>sender: object</strong></dt>
<dd><pclass="first last">Object that requested the tool to be triggered</p>
</dd>
<dt><strong>data: object</strong></dt>
<dd><pclass="first last">Extra data</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolQuitAll">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolQuitAll</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolQuitAll"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolQuitAll" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['W', 'cmd+W', 'Q']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolQuitAll.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Quit all figures'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolQuitAll.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">trigger</code><spanclass="sig-paren">(</span><em>sender</em>, <em>event</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolQuitAll.trigger"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolQuitAll.trigger" 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>event: `Event`</strong></dt>
<dd><pclass="first last">The Canvas event that caused this tool to be called</p>
</dd>
<dt><strong>sender: object</strong></dt>
<dd><pclass="first last">Object that requested the tool to be triggered</p>
</dd>
<dt><strong>data: object</strong></dt>
<dd><pclass="first last">Extra data</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolToggleBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolToggleBase</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolToggleBase"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolToggleBase" 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>``*args``</strong></dt>
<dd><pclass="first last">Variable length argument to be used by the Tool</p>
</dd>
<dt><strong>``**kwargs``</strong></dt>
<dd><pclass="first last"><aclass="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="matplotlib.backend_tools.ToolToggleBase.toggled"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">toggled</span></code></a> if present and True, sets the initial state of the Tool
Arbitrary keyword arguments to be consumed by the Tool</p>
<codeclass="descname">cursor</code><emclass="property"> = None</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.cursor" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_toggled</code><emclass="property"> = False</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.default_toggled" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">disable</code><spanclass="sig-paren">(</span><em>event=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolToggleBase.disable"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.disable" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable the toggle tool</p>
<p><aclass="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.trigger" title="matplotlib.backend_tools.ToolToggleBase.trigger"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">trigger</span></code></a> call this method when <aclass="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="matplotlib.backend_tools.ToolToggleBase.toggled"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">toggled</span></code></a> is True.</p>
<codeclass="descname">enable</code><spanclass="sig-paren">(</span><em>event=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolToggleBase.enable"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.enable" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable the toggle tool</p>
<p><aclass="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.trigger" title="matplotlib.backend_tools.ToolToggleBase.trigger"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">trigger</span></code></a> calls this method when <aclass="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="matplotlib.backend_tools.ToolToggleBase.toggled"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">toggled</span></code></a> is False</p>
<codeclass="descname">radio_group</code><emclass="property"> = None</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.radio_group" title="Permalink to this definition">¶</a></dt>
<dd><p>Attribute to group 'radio' like tools (mutually exclusive)</p>
<p><strong>String</strong> that identifies the group or <strong>None</strong> if not belonging to a
<codeclass="descname">set_figure</code><spanclass="sig-paren">(</span><em>figure</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolToggleBase.set_figure"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.set_figure" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">toggled</code><aclass="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">trigger</code><spanclass="sig-paren">(</span><em>sender</em>, <em>event</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolToggleBase.trigger"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.trigger" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolViewsPositions</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">add_figure</code><spanclass="sig-paren">(</span><em>figure</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.add_figure"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.add_figure" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the current figure to the stack of views and positions</p>
<codeclass="descname">back</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.back"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.back" title="Permalink to this definition">¶</a></dt>
<dd><p>Back one step in the stack of views and positions</p>
<codeclass="descname">clear</code><spanclass="sig-paren">(</span><em>figure</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.clear"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.clear" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">forward</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.forward"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Forward one step in the stack of views and positions</p>
<codeclass="descname">home</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.home"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.home" title="Permalink to this definition">¶</a></dt>
<dd><p>Recall the first view and position from the stack</p>
<codeclass="descname">push_current</code><spanclass="sig-paren">(</span><em>figure=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.push_current"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.push_current" title="Permalink to this definition">¶</a></dt>
<dd><p>Push the current view limits and position onto their respective stacks</p>
<codeclass="descname">refresh_locators</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.refresh_locators"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.refresh_locators" title="Permalink to this definition">¶</a></dt>
<dd><p>Redraw the canvases, update the locators</p>
<codeclass="descname">update_home_views</code><spanclass="sig-paren">(</span><em>figure=None</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.update_home_views"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.update_home_views" title="Permalink to this definition">¶</a></dt>
<dd><p>Make sure that self.home_views has an entry for all axes present in the
<codeclass="descname">update_view</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolViewsPositions.update_view"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.update_view" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the view limits and position for each axes from the current
stack position. If any axes are present in the figure that aren't in
the current stack position, use the home view limits for those axes and
don't update <em>any</em> positions.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolXScale">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolXScale</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal" href="../_modules/matplotlib/backend_tools.html#ToolXScale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink" href="#matplotlib.backend_tools.ToolXScale" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['k', 'L']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolXScale.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Toogle Scale X axis'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolXScale.description" title="Permalink to this definition">¶</a></dt>