interactive-figure 0.3.4__tar.gz → 0.3.6__tar.gz

{interactive_figure-0.3.4 → interactive_figure-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: interactive-figure
-Version: 0.3.4
+Version: 0.3.6
 Summary: Create interactive Matplotlib figures!
 Project-URL: Documentation, https://teuncm.github.io/interactive-figure/autoapi/interactive_figure/interactive_figure/index.html
 Project-URL: Issues, https://github.com/teuncm/interactive-figure/issues
@@ -63,6 +63,9 @@ hatch shell
 hatch version fix
 hatch build -c
 ./generate_docs.sh
+
+# Publish
+hatch publish
 ```
 
 ## Links

{interactive_figure-0.3.4 → interactive_figure-0.3.6}/README.md

@@ -43,6 +43,9 @@ hatch shell
 hatch version fix
 hatch build -c
 ./generate_docs.sh
+
+# Publish
+hatch publish
 ```
 
 ## Links

{interactive_figure-0.3.4 → interactive_figure-0.3.6}/docs/_sources/autoapi/interactive_figure/interactive_figure/index.rst.txt

@@ -39,14 +39,14 @@ Module Contents
    Parameters
    ----------
    aspect_ratio : str, optional
-       aspect ratio of the Axes, by default "auto"
+       aspect ratio of the Axes, default "auto".
    hide_toolbar : bool, optional
-       whether to hide the toolbar, by default False
+       whether to hide the toolbar, default False.
 
-   remaining arguments will be sent to the figure upon creation
+   Remaining arguments will be sent to the figure upon creation.
 
    Raises
-   ------
+   ----------
    RuntimeError
        if multiple interactive figures are created.
 
@@ -58,10 +58,14 @@ Module Contents
 
 .. py:function:: clear(hide_labels=False, set_limits=True)
 
-   Reset contents and layout of the figure. 
+   Reset contents and layout of the figure.
 
-   *set_limits* will set the Axes limits to 
-   [0, 100]. *hide_labels* will remove all labels.
+   Parameters
+   ----------
+   set_limits : bool, optional
+       set the Axes limits to [0, 100].
+   hide_labels : bool, optional
+       remove all labels from the figure.
 
 
 .. py:function:: toggle_fullscreen()
@@ -100,7 +104,7 @@ Module Contents
    Returns
    -------
    str | None
-       The last key that was pressed
+       The last key that was pressed.
 
 
 .. py:function:: get_last_mouse_press()
@@ -110,7 +114,7 @@ Module Contents
    Returns
    -------
    int | None
-       The identifier of the last mouse button that was pressed
+       The identifier of the last mouse button that was pressed.
 
 
 .. py:function:: get_last_mouse_pos()
@@ -120,7 +124,7 @@ Module Contents
    Returns
    -------
    (x: float, y: float) | (None, None)
-       The last registered mouse position after any interaction
+       The last registered mouse position after any interaction.
 
 
 .. py:function:: wait(timeout)
@@ -133,6 +137,6 @@ Module Contents
    Parameters
    ----------
    timeout : float
-       Number of seconds to wait for
+       Number of seconds to wait for.
 
 

{interactive_figure-0.3.4 → interactive_figure-0.3.6}/docs/autoapi/interactive_figure/interactive_figure/index.html

@@ -132,12 +132,12 @@ after any input.</p>
 <section id="parameters">
 <h3>Parameters<a class="headerlink" href="#parameters" title="Link to this heading"></a></h3>
 <dl class="simple">
-<dt>aspect_ratio<span class="classifier">str, optional</span></dt><dd><p>aspect ratio of the Axes, by default “auto”</p>
+<dt>aspect_ratio<span class="classifier">str, optional</span></dt><dd><p>aspect ratio of the Axes, default “auto”.</p>
 </dd>
-<dt>hide_toolbar<span class="classifier">bool, optional</span></dt><dd><p>whether to hide the toolbar, by default False</p>
+<dt>hide_toolbar<span class="classifier">bool, optional</span></dt><dd><p>whether to hide the toolbar, default False.</p>
 </dd>
 </dl>
-<p>remaining arguments will be sent to the figure upon creation</p>
+<p>Remaining arguments will be sent to the figure upon creation.</p>
 </section>
 <section id="raises">
 <h3>Raises<a class="headerlink" href="#raises" title="Link to this heading"></a></h3>
@@ -158,8 +158,15 @@ after any input.</p>
 <dt class="sig sig-object py" id="interactive_figure.interactive_figure.clear">
 <span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">hide_labels</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">set_limits</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#interactive_figure.interactive_figure.clear" title="Link to this definition"></a></dt>
 <dd><p>Reset contents and layout of the figure.</p>
-<p><em>set_limits</em> will set the Axes limits to
-[0, 100]. <em>hide_labels</em> will remove all labels.</p>
+<section id="id1">
+<h3>Parameters<a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
+<dl class="simple">
+<dt>set_limits<span class="classifier">bool, optional</span></dt><dd><p>set the Axes limits to [0, 100].</p>
+</dd>
+<dt>hide_labels<span class="classifier">bool, optional</span></dt><dd><p>remove all labels from the figure.</p>
+</dd>
+</dl>
+</section>
 </dd></dl>
 
 <dl class="py function">
@@ -179,8 +186,8 @@ after any input.</p>
 <span class="sig-name descname"><span class="pre">wait_for_interaction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#interactive_figure.interactive_figure.wait_for_interaction" title="Link to this definition"></a></dt>
 <dd><p>Wait for interaction.</p>
 <p>Optionally use a timeout in seconds.</p>
-<section id="id1">
-<h3>Parameters<a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
+<section id="id2">
+<h3>Parameters<a class="headerlink" href="#id2" title="Link to this heading"></a></h3>
 <dl class="simple">
 <dt>timeout<span class="classifier">int, optional</span></dt><dd><p>Timeout in seconds when waiting for input.</p>
 </dd>
@@ -203,10 +210,10 @@ after any input.</p>
 <dt class="sig sig-object py" id="interactive_figure.interactive_figure.get_last_key_press">
 <span class="sig-name descname"><span class="pre">get_last_key_press</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#interactive_figure.interactive_figure.get_last_key_press" title="Link to this definition"></a></dt>
 <dd><p>Get the last key press in lowercase.</p>
-<section id="id2">
-<h3>Returns<a class="headerlink" href="#id2" title="Link to this heading"></a></h3>
+<section id="id3">
+<h3>Returns<a class="headerlink" href="#id3" title="Link to this heading"></a></h3>
 <dl class="simple">
-<dt>str | None</dt><dd><p>The last key that was pressed</p>
+<dt>str | None</dt><dd><p>The last key that was pressed.</p>
 </dd>
 </dl>
 </section>
@@ -216,10 +223,10 @@ after any input.</p>
 <dt class="sig sig-object py" id="interactive_figure.interactive_figure.get_last_mouse_press">
 <span class="sig-name descname"><span class="pre">get_last_mouse_press</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#interactive_figure.interactive_figure.get_last_mouse_press" title="Link to this definition"></a></dt>
 <dd><p>Get the ID of the last mouse press.</p>
-<section id="id3">
-<h3>Returns<a class="headerlink" href="#id3" title="Link to this heading"></a></h3>
+<section id="id4">
+<h3>Returns<a class="headerlink" href="#id4" title="Link to this heading"></a></h3>
 <dl class="simple">
-<dt>int | None</dt><dd><p>The identifier of the last mouse button that was pressed</p>
+<dt>int | None</dt><dd><p>The identifier of the last mouse button that was pressed.</p>
 </dd>
 </dl>
 </section>
@@ -229,10 +236,10 @@ after any input.</p>
 <dt class="sig sig-object py" id="interactive_figure.interactive_figure.get_last_mouse_pos">
 <span class="sig-name descname"><span class="pre">get_last_mouse_pos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#interactive_figure.interactive_figure.get_last_mouse_pos" title="Link to this definition"></a></dt>
 <dd><p>Get the last mouse position.</p>
-<section id="id4">
-<h3>Returns<a class="headerlink" href="#id4" title="Link to this heading"></a></h3>
+<section id="id5">
+<h3>Returns<a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
 <dl class="simple">
-<dt>(x: float, y: float) | (None, None)</dt><dd><p>The last registered mouse position after any interaction</p>
+<dt>(x: float, y: float) | (None, None)</dt><dd><p>The last registered mouse position after any interaction.</p>
 </dd>
 </dl>
 </section>
@@ -244,10 +251,10 @@ after any input.</p>
 <dd><p>Freeze for the given number of seconds.</p>
 <p>During this period it is not possible to interact
 with the figure. For sub-second timeouts use time.wait() instead.</p>
-<section id="id5">
-<h3>Parameters<a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
+<section id="id6">
+<h3>Parameters<a class="headerlink" href="#id6" title="Link to this heading"></a></h3>
 <dl class="simple">
-<dt>timeout<span class="classifier">float</span></dt><dd><p>Number of seconds to wait for</p>
+<dt>timeout<span class="classifier">float</span></dt><dd><p>Number of seconds to wait for.</p>
 </dd>
 </dl>
 </section>

interactive_figure-0.3.6/docs/searchindex.js

@@ -0,0 +1 @@
+Search.setIndex({"alltitles": {"API Reference": [[0, null]], "Functions": [[2, "functions"]], "Module Contents": [[2, "module-contents"]], "Parameters": [[2, "parameters"], [2, "id1"], [2, "id2"], [2, "id6"]], "Raises": [[2, "raises"]], "Returns": [[2, "returns"], [2, "id3"], [2, "id4"], [2, "id5"]], "Submodules": [[1, "submodules"]], "Welcome to Interactive Figure\u2019s documentation!": [[3, null]], "interactive_figure": [[1, null]], "interactive_figure.interactive_figure": [[2, null]]}, "docnames": ["autoapi/index", "autoapi/interactive_figure/index", "autoapi/interactive_figure/interactive_figure/index", "index"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["autoapi\\index.rst", "autoapi\\interactive_figure\\index.rst", "autoapi\\interactive_figure\\interactive_figure\\index.rst", "index.rst"], "indexentries": {"clear() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.clear", false]], "close() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.close", false]], "create() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.create", false]], "draw() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.draw", false]], "get_last_key_press() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.get_last_key_press", false]], "get_last_mouse_pos() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.get_last_mouse_pos", false]], "get_last_mouse_press() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.get_last_mouse_press", false]], "interactive_figure": [[1, "module-interactive_figure", false]], "interactive_figure.interactive_figure": [[2, "module-interactive_figure.interactive_figure", false]], "module": [[1, "module-interactive_figure", false], [2, "module-interactive_figure.interactive_figure", false]], "toggle_fullscreen() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.toggle_fullscreen", false]], "wait() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.wait", false]], "wait_for_interaction() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.wait_for_interaction", false]]}, "objects": {"": [[1, 0, 0, "-", "interactive_figure"]], "interactive_figure": [[2, 0, 0, "-", "interactive_figure"]], "interactive_figure.interactive_figure": [[2, 1, 1, "", "clear"], [2, 1, 1, "", "close"], [2, 1, 1, "", "create"], [2, 1, 1, "", "draw"], [2, 1, 1, "", "get_last_key_press"], [2, 1, 1, "", "get_last_mouse_pos"], [2, 1, 1, "", "get_last_mouse_press"], [2, 1, 1, "", "toggle_fullscreen"], [2, 1, 1, "", "wait"], [2, 1, 1, "", "wait_for_interaction"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"0": 2, "1": [0, 2], "100": 2, "For": 2, "The": 2, "after": 2, "all": 2, "an": [], "ani": 2, "api": 3, "ar": 2, "argument": 2, "aspect": 2, "aspect_ratio": 2, "auto": [0, 2], "autoapi": 0, "ax": 2, "bool": 2, "button": 2, "clear": 2, "close": 2, "com": 2, "contain": 0, "control": [], "convert": [], "creat": [0, 2], "creation": 2, "default": 2, "document": 0, "draw": 2, "dure": 2, "fals": 2, "figur": 2, "fine": [], "float": 2, "freez": 2, "from": 2, "fullscreen": 2, "gener": 0, "get": 2, "get_last_key_press": 2, "get_last_mouse_po": 2, "get_last_mouse_press": 2, "github": 2, "given": 2, "grain": [], "ha": [], "hide": 2, "hide_label": 2, "hide_toolbar": 2, "http": 2, "i": 2, "id": 2, "identifi": 2, "input": 2, "instead": 2, "int": 2, "integ": [], "interact": 2, "interactive_figur": [0, 3], "kei": 2, "keyboard": 2, "keypress": [], "kwarg": 2, "label": 2, "last": 2, "layout": 2, "limit": 2, "locat": 2, "lowercas": 2, "matplotlib": 2, "mous": 2, "mousepress": [], "multipl": 2, "none": 2, "number": 2, "option": 2, "over": [], "page": 0, "period": 2, "posit": 2, "possibl": 2, "press": 2, "provid": 2, "ratio": 2, "refer": 3, "regist": 2, "remain": 2, "remov": 2, "reset": 2, "runtimeerror": 2, "second": 2, "sent": 2, "set": 2, "set_limit": 2, "sourc": 2, "sphinx": 0, "str": 2, "sub": 2, "teuncm": 2, "thi": [0, 2], "time": 2, "timeout": 2, "toggl": 2, "toggle_fullscreen": 2, "toolbar": 2, "true": 2, "upon": 2, "us": 2, "user": [], "valu": [], "wa": 2, "wait": 2, "wait_for_interact": 2, "when": 2, "whether": 2, "within": 2, "x": 2, "y": 2}, "titles": ["API Reference", "interactive_figure", "interactive_figure.interactive_figure", "Welcome to Interactive Figure\u2019s documentation!"], "titleterms": {"": 3, "api": 0, "content": 2, "document": 3, "figur": 3, "function": 2, "interact": 3, "interactive_figur": [1, 2], "modul": 2, "paramet": 2, "rais": 2, "refer": 0, "return": 2, "submodul": 1, "welcom": 3}})

interactive_figure-0.3.6/src/interactive_figure/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.3.6"

{interactive_figure-0.3.4 → interactive_figure-0.3.6}/src/interactive_figure/interactive_figure.py

@@ -7,6 +7,7 @@ Source: https://github.com/teuncm/interactive-figure
 
 import matplotlib.pyplot as plt
 from types import SimpleNamespace
+import sys
 
 
 def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
@@ -15,14 +16,14 @@ def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
     Parameters
     ----------
     aspect_ratio : str, optional
-        aspect ratio of the Axes, by default "auto"
+        aspect ratio of the Axes, default "auto".
     hide_toolbar : bool, optional
-        whether to hide the toolbar, by default False
+        whether to hide the toolbar, default False.
 
-    remaining arguments will be sent to the figure upon creation
+    Remaining arguments will be sent to the figure upon creation.
 
     Raises
-    ------
+    ----------
     RuntimeError
         if multiple interactive figures are created.
     """
@@ -57,10 +58,12 @@ def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
         fig.canvas.mpl_disconnect(fig.canvas.manager.button_press_handler_id)
         fig.canvas.mpl_connect("key_press_event", _key_press_handler)
         fig.canvas.mpl_connect("button_press_event", _button_press_handler)
+        fig.canvas.mpl_connect("close_event", _close_handler)
 
-        print("Successfully created the interactive figure.")
+        print("Interactive figure: created")
     else:
-        raise RuntimeError("Error: you cannot create multiple interactive figures.")
+        raise RuntimeError("Error: you cannot create multiple interactive figures at the same time.")
+
 
 def draw():
     """Draw contents of the figure."""
@@ -75,10 +78,15 @@ def draw():
 
 
 def clear(hide_labels=False, set_limits=True):
-    """Reset contents and layout of the figure. 
-    
-    *set_limits* will set the Axes limits to 
-    [0, 100]. *hide_labels* will remove all labels."""
+    """Reset contents and layout of the figure.
+
+    Parameters
+    ----------
+    set_limits : bool, optional
+        set the Axes limits to [0, 100].
+    hide_labels : bool, optional
+        remove all labels from the figure.
+    """
     _check_exists()
 
     ax = _state.ax
@@ -104,13 +112,13 @@ def close():
     """Close the figure."""
     _check_exists()
 
+    _state.closed_using_ui = False
     plt.close(_state.fig)
 
+    # Handle proper closure so that the figure can be reused.
     _state_reset_fig()
     _state_reset_press()
 
-    print("Successfully closed the interactive figure.")
-
 
 def wait_for_interaction(timeout=-1):
     """Wait for interaction. 
@@ -160,7 +168,7 @@ def wait_for_interaction(timeout=-1):
     interaction_type = None if event is None else event.name == "key_press_event"
 
     if interaction_type is None:
-        # No button was pressed, so reset the state.
+        # No button was pressed, so reset the press state.
         _state_reset_press()
 
     return interaction_type
@@ -172,7 +180,7 @@ def get_last_key_press():
     Returns
     -------
     str | None
-        The last key that was pressed
+        The last key that was pressed.
     """
     _check_exists()
 
@@ -190,7 +198,7 @@ def get_last_mouse_press():
     Returns
     -------
     int | None
-        The identifier of the last mouse button that was pressed
+        The identifier of the last mouse button that was pressed.
     """
     _check_exists()
 
@@ -208,7 +216,7 @@ def get_last_mouse_pos():
     Returns
     -------
     (x: float, y: float) | (None, None)
-        The last registered mouse position after any interaction
+        The last registered mouse position after any interaction.
     """
     _check_exists()
 
@@ -224,16 +232,16 @@ def wait(timeout):
     Parameters
     ----------
     timeout : float
-        Number of seconds to wait for
+        Number of seconds to wait for.
     """
     _check_exists()
 
     _state.fig.canvas.start_event_loop(timeout=timeout)
-    # No button was pressed, so reset the state.
+    # Reset the press state.
     _state_reset_press()
 
 
-# PRIVATE METHODS
+# HIDDEN METHODS
 
 
 def _get_state():
@@ -263,6 +271,7 @@ def _state_reset_fig():
     """Reset figure information."""
     _state.fig = None
     _state.ax = None
+    _state.closed_using_ui = True
 
 
 def _state_reset_press():
@@ -301,6 +310,23 @@ def _button_press_handler(event):
     _state.last_mouse_y = event.ydata
 
 
+def _close_handler(event):
+    """Exit when the user presses the red x to close the figure
+    to prevent an infinite event loop.
+    
+    Parameters
+    ----------
+    event
+        The event object that was generated internally
+    """
+    print("Interactive figure: closed")
+
+    # Triggered if the UI ('the red x') is used to close the figure.
+    if _state.closed_using_ui:
+        print("Interactive figure: exited script")       
+        sys.exit(0)
+
+
 # Namespace to track the internal state of the interactive figure.
 _state = SimpleNamespace(
     fig=None,
@@ -309,4 +335,5 @@ _state = SimpleNamespace(
     last_mousepress=None,
     last_mouse_x=None,
     last_mouse_y=None,
+    closed_using_ui=True
 )

interactive_figure-0.3.4/docs/searchindex.js

@@ -1 +0,0 @@
-Search.setIndex({"alltitles": {"API Reference": [[0, null]], "Functions": [[2, "functions"]], "Module Contents": [[2, "module-contents"]], "Parameters": [[2, "parameters"], [2, "id1"], [2, "id5"]], "Raises": [[2, "raises"]], "Returns": [[2, "returns"], [2, "id2"], [2, "id3"], [2, "id4"]], "Submodules": [[1, "submodules"]], "Welcome to Interactive Figure\u2019s documentation!": [[3, null]], "interactive_figure": [[1, null]], "interactive_figure.interactive_figure": [[2, null]]}, "docnames": ["autoapi/index", "autoapi/interactive_figure/index", "autoapi/interactive_figure/interactive_figure/index", "index"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["autoapi\\index.rst", "autoapi\\interactive_figure\\index.rst", "autoapi\\interactive_figure\\interactive_figure\\index.rst", "index.rst"], "indexentries": {"clear() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.clear", false]], "close() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.close", false]], "create() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.create", false]], "draw() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.draw", false]], "get_last_key_press() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.get_last_key_press", false]], "get_last_mouse_pos() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.get_last_mouse_pos", false]], "get_last_mouse_press() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.get_last_mouse_press", false]], "interactive_figure": [[1, "module-interactive_figure", false]], "interactive_figure.interactive_figure": [[2, "module-interactive_figure.interactive_figure", false]], "module": [[1, "module-interactive_figure", false], [2, "module-interactive_figure.interactive_figure", false]], "toggle_fullscreen() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.toggle_fullscreen", false]], "wait() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.wait", false]], "wait_for_interaction() (in module interactive_figure.interactive_figure)": [[2, "interactive_figure.interactive_figure.wait_for_interaction", false]]}, "objects": {"": [[1, 0, 0, "-", "interactive_figure"]], "interactive_figure": [[2, 0, 0, "-", "interactive_figure"]], "interactive_figure.interactive_figure": [[2, 1, 1, "", "clear"], [2, 1, 1, "", "close"], [2, 1, 1, "", "create"], [2, 1, 1, "", "draw"], [2, 1, 1, "", "get_last_key_press"], [2, 1, 1, "", "get_last_mouse_pos"], [2, 1, 1, "", "get_last_mouse_press"], [2, 1, 1, "", "toggle_fullscreen"], [2, 1, 1, "", "wait"], [2, 1, 1, "", "wait_for_interaction"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"0": 2, "1": [0, 2], "100": 2, "For": 2, "The": 2, "after": 2, "all": 2, "an": [], "ani": 2, "api": 3, "ar": 2, "argument": 2, "aspect": 2, "aspect_ratio": 2, "auto": [0, 2], "autoapi": 0, "ax": 2, "bool": 2, "button": 2, "clear": 2, "close": 2, "com": 2, "contain": 0, "control": [], "convert": [], "creat": [0, 2], "creation": 2, "default": 2, "document": 0, "draw": 2, "dure": 2, "fals": 2, "figur": 2, "fine": [], "float": 2, "freez": 2, "fullscreen": 2, "gener": 0, "get": 2, "get_last_key_press": 2, "get_last_mouse_po": 2, "get_last_mouse_press": 2, "github": 2, "given": 2, "grain": [], "ha": [], "hide": 2, "hide_label": 2, "hide_toolbar": 2, "http": 2, "i": 2, "id": 2, "identifi": 2, "input": 2, "instead": 2, "int": 2, "integ": [], "interact": 2, "interactive_figur": [0, 3], "kei": 2, "keyboard": 2, "keypress": [], "kwarg": 2, "label": 2, "last": 2, "layout": 2, "limit": 2, "locat": 2, "lowercas": 2, "matplotlib": 2, "mous": 2, "mousepress": [], "multipl": 2, "none": 2, "number": 2, "option": 2, "over": [], "page": 0, "period": 2, "posit": 2, "possibl": 2, "press": 2, "provid": 2, "ratio": 2, "refer": 3, "regist": 2, "remain": 2, "remov": 2, "reset": 2, "runtimeerror": 2, "second": 2, "sent": 2, "set": 2, "set_limit": 2, "sourc": 2, "sphinx": 0, "str": 2, "sub": 2, "teuncm": 2, "thi": [0, 2], "time": 2, "timeout": 2, "toggl": 2, "toggle_fullscreen": 2, "toolbar": 2, "true": 2, "upon": 2, "us": 2, "user": [], "valu": [], "wa": 2, "wait": 2, "wait_for_interact": 2, "when": 2, "whether": 2, "within": 2, "x": 2, "y": 2}, "titles": ["API Reference", "interactive_figure", "interactive_figure.interactive_figure", "Welcome to Interactive Figure\u2019s documentation!"], "titleterms": {"": 3, "api": 0, "content": 2, "document": 3, "figur": 3, "function": 2, "interact": 3, "interactive_figur": [1, 2], "modul": 2, "paramet": 2, "rais": 2, "refer": 0, "return": 2, "submodul": 1, "welcom": 3}})

interactive_figure-0.3.4/src/interactive_figure/__about__.py

@@ -1 +0,0 @@
-__version__ = "0.3.4"