.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "gallery/other/plot_mouse_hover.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_gallery_other_plot_mouse_hover.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_gallery_other_plot_mouse_hover.py:


Mouse event handling
====================

This example shows how to interact with mouse events (e.g. hovering) in `iplotx`.

.. warning::
  This example will run in a Python, IPython, or Jupyter session, however the
  interactive functionality is not visible on the HTML page. Download the code
  at the end of this page and run it in a local Python environment to see
  the results.

.. GENERATED FROM PYTHON SOURCE LINES 13-67



.. image-sg:: /gallery/other/images/sphx_glr_plot_mouse_hover_001.png
   :alt: plot mouse hover
   :srcset: /gallery/other/images/sphx_glr_plot_mouse_hover_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    12





|

.. code-block:: Python


    import matplotlib.pyplot as plt
    import igraph as ig
    import iplotx as ipx

    g = ig.Graph.Ring(3, directed=True)

    fig, ax = plt.subplots()
    art = ipx.network(
        g,
        layout="circle",
        ax=ax,
        aspect=1,
    )[0]
    vertex_artist = art.get_vertices()

    # Prepare an invisible annotation for hovering
    annot = ax.annotate(
        "",
        xy=(0, 0),
        xytext=(20, 20),
        textcoords="offset points",
        bbox=dict(boxstyle="round", fc=(0, 0, 0, 0.2)),
        arrowprops=dict(arrowstyle="->"),
    )
    annot.set_visible(False)


    def hover_callback(event):
        """React to mouse hovering over vertices."""
        if event.inaxes == ax:
            vc = art.get_vertices()
            cont, ind = vc.contains(event)
            # If mouse is over a vertex, show the bubble
            if cont:
                i = ind["ind"][0]
                annot.xy = vc.get_offsets()[i]
                annot.set_text(f"{i + 1}")
                annot.set_visible(True)
            # Otherwise, hide the bubble
            elif annot.get_visible():
                annot.set_visible(False)
            # If nothing changed, no need to redraw
            else:
                return

            # Redraw to show/hide the bubble
            fig.canvas.draw_idle()


    fig.canvas.mpl_connect(
        "motion_notify_event",
        hover_callback,
    )


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.031 seconds)


.. _sphx_glr_download_gallery_other_plot_mouse_hover.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_mouse_hover.ipynb <plot_mouse_hover.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_mouse_hover.py <plot_mouse_hover.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_mouse_hover.zip <plot_mouse_hover.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_