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 (v1.5.1). 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"><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"><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="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="headerlink" href="#matplotlib.backend_tools.AxisScaleBase.disable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">enable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.AxisScaleBase.enable" 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="headerlink" href="#matplotlib.backend_tools.AxisScaleBase.trigger" title="Permalink to this definition">¶</a></dt>
<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="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.png'</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="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>
</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="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="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="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="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"><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"><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="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.png'</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="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="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>
</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="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.png'</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="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"><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"><spanclass="pre">matplotlib.backend_managers.ToolManager</span></code></a></p>
<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 emited</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="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"><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">trigger</code><spanclass="sig-paren">(</span><em>sender</em>, <em>event</em>, <em>data=None</em><spanclass="sig-paren">)</span><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="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="headerlink" href="#matplotlib.backend_tools.ToolCursorPosition.send_message" 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="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="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="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="headerlink" href="#matplotlib.backend_tools.ToolEnableNavigation.trigger" title="Permalink to this definition">¶</a></dt>
<dd></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="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.png'</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="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="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.disable" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">enable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ToolFullScreen.enable" title="Permalink to this definition">¶</a></dt>
<dd></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>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><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 Grid'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolGrid.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">disable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ToolGrid.disable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="matplotlib.backend_tools.ToolGrid.enable">
<codeclass="descname">enable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ToolGrid.enable" 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="headerlink" href="#matplotlib.backend_tools.ToolGrid.trigger" 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="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.png'</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.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="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.png'</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="headerlink" href="#matplotlib.backend_tools.ToolQuit" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['ctrl+w', 'cmd+w']</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="headerlink" href="#matplotlib.backend_tools.ToolQuit.trigger" title="Permalink to this definition">¶</a></dt>
<dd></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="headerlink" href="#matplotlib.backend_tools.ToolToggleBase" title="Permalink to this definition">¶</a></dt>
<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">disable</code><spanclass="sig-paren">(</span><em>event=None</em><spanclass="sig-paren">)</span><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"><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"><spanclass="pre">toggled</span></code></a> is True.</p>
<p>This can happen in different circumstances</p>
<ulclass="simple">
<li>Click on the toolbar tool button</li>
<li>Call to <aclass="reference internal" href="backend_managers_api.html#matplotlib.backend_managers.ToolManager.trigger_tool" title="matplotlib.backend_managers.ToolManager.trigger_tool"><codeclass="xref py py-obj docutils literal"><spanclass="pre">matplotlib.backend_managers.ToolManager.trigger_tool</span></code></a></li>
<codeclass="descname">enable</code><spanclass="sig-paren">(</span><em>event=None</em><spanclass="sig-paren">)</span><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"><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"><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">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="headerlink" href="#matplotlib.backend_tools.ToolToggleBase.trigger" title="Permalink to this definition">¶</a></dt>
<dd><p>Calls <aclass="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.enable" title="matplotlib.backend_tools.ToolToggleBase.enable"><codeclass="xref py py-obj docutils literal"><spanclass="pre">enable</span></code></a> or <aclass="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.disable" title="matplotlib.backend_tools.ToolToggleBase.disable"><codeclass="xref py py-obj docutils literal"><spanclass="pre">disable</span></code></a> based on <aclass="reference internal" href="#matplotlib.backend_tools.ToolToggleBase.toggled" title="matplotlib.backend_tools.ToolToggleBase.toggled"><codeclass="xref py py-obj docutils literal"><spanclass="pre">toggled</span></code></a> value</p>
<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="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">add_figure</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><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="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="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="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="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><spanclass="sig-paren">)</span><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 the stack</p>
<codeclass="descname">refresh_locators</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><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_view</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ToolViewsPositions.update_view" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the viewlim and position from the view and
position stack for each axes</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="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>
<codeclass="descname">set_scale</code><spanclass="sig-paren">(</span><em>ax</em>, <em>scale</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ToolXScale.set_scale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolYScale">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolYScale</code><spanclass="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ToolYScale" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['l']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolYScale.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Toogle Scale Y axis'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolYScale.description" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_scale</code><spanclass="sig-paren">(</span><em>ax</em>, <em>scale</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ToolYScale.set_scale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ToolZoom">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ToolZoom</code><spanclass="sig-paren">(</span><em>*args</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ToolZoom" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">cursor</code><emclass="property"> = 2</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolZoom.cursor" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">default_keymap</code><emclass="property"> = ['o']</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolZoom.default_keymap" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">description</code><emclass="property"> = 'Zoom to rectangle'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolZoom.description" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="matplotlib.backend_tools.ToolZoom.image">
<codeclass="descname">image</code><emclass="property"> = 'zoom_to_rect.png'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolZoom.image" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">radio_group</code><emclass="property"> = 'default'</em><aclass="headerlink" href="#matplotlib.backend_tools.ToolZoom.radio_group" title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ViewsPositionsBase</code><spanclass="sig-paren">(</span><em>toolmanager</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ViewsPositionsBase" 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="headerlink" href="#matplotlib.backend_tools.ViewsPositionsBase.trigger" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="matplotlib.backend_tools.ZoomPanBase">
<emclass="property">class </em><codeclass="descclassname">matplotlib.backend_tools.</code><codeclass="descname">ZoomPanBase</code><spanclass="sig-paren">(</span><em>*args</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ZoomPanBase" title="Permalink to this definition">¶</a></dt>
<codeclass="descname">disable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ZoomPanBase.disable" title="Permalink to this definition">¶</a></dt>
<dd><p>Release the canvas and disconnect press/release events</p>
<codeclass="descname">enable</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ZoomPanBase.enable" title="Permalink to this definition">¶</a></dt>
<dd><p>Connect press/release events and lock the canvas</p>
<codeclass="descname">scroll_zoom</code><spanclass="sig-paren">(</span><em>event</em><spanclass="sig-paren">)</span><aclass="headerlink" href="#matplotlib.backend_tools.ZoomPanBase.scroll_zoom" 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="headerlink" href="#matplotlib.backend_tools.ZoomPanBase.trigger" title="Permalink to this definition">¶</a></dt>
<div><p><codeclass="xref py py-obj docutils literal"><spanclass="pre">backend_bases.ToolContainerBase</span></code> object that will get the tools added</p>
</div></blockquote>
<p><strong>tools</strong> : list, optional</p>
<blockquoteclass="last">
<div><p>List in the form
[[group1, [tool1, tool2 ...]], [group2, [...]]]
Where the tools given by tool1, and tool2 will display in group1.
See <codeclass="xref py py-obj docutils literal"><spanclass="pre">add_tool</span></code> for details.</p>
<div><p><codeclass="xref py py-obj docutils literal"><spanclass="pre">backend_managers.ToolManager</span></code> object that will get the tools added</p>