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

.. only:: html

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

        Click :ref:`here <sphx_glr_download_sphinx_gallery_output_plot_19_hyperlinks.py>`
        to download the full example code

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

.. _sphx_glr_sphinx_gallery_output_plot_19_hyperlinks.py:

Hyperlinks
==========

Non-interactive figures
-----------------------

Netgraph uses matplotlib to draw all figure elements, and `matplotib
has only limited support for hyperlinks`_. Specifically, you have to use the
SVG backend or export the figure to SVG.

.. _matplotib has only limited support for hyperlinks: https://matplotlib.org/stable/gallery/misc/hyperlinks_sgskip.html

.. GENERATED FROM PYTHON SOURCE LINES 15-28

.. code-block:: default


    import matplotlib.pyplot as plt

    from netgraph import Graph

    fig, ax = plt.subplots()
    g = Graph([(0, 1)], ax=ax)

    g.node_artists[0].set_url("https://www.google.com")
    g.edge_artists[(0, 1)].set_url("https://www.stackoverflow.com")

    fig.savefig('image.svg')




.. image-sg:: /sphinx_gallery_output/images/sphx_glr_plot_19_hyperlinks_001.png
   :alt: plot 19 hyperlinks
   :srcset: /sphinx_gallery_output/images/sphx_glr_plot_19_hyperlinks_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 29-44

Opening the image.svg file in a browser of your choice, you can click on
the plot elements to open the corresponding web pages.

Interactive figures
-------------------

Technically, matplotlib does not support hyperlinks when using an
interactive backend. However, hyperlink behaviour can easily be
emulated using `matplotlib pick-events`_ and the python in-built
:code:`webbrowser` module. Note that these hyperlinks are not
available when exporting the figure (unless the figure is exported
to SVG). Clicking on the PNG image embedded below will hence have
no effect.

.. _matplotlib pick-events: https://matplotlib.org/stable/gallery/event_handling/pick_event_demo.html

.. GENERATED FROM PYTHON SOURCE LINES 44-76

.. code-block:: default


    import webbrowser
    import matplotlib.pyplot as plt

    from netgraph import Graph

    def on_pick(event):
        webbrowser.open(event.artist.get_url())

    fig, ax = plt.subplots()

    fig.canvas.mpl_connect('pick_event', on_pick)

    g = Graph([(0, 1)],
              node_labels={1 : "https://www.github.com"},
              node_label_offset=0.1,
              edge_labels={(0, 1) : "https://matplotlib.org/"},
              ax=ax)

    g.node_artists[0].set_picker(True)
    g.node_artists[0].set_url("https://www.google.com")

    g.edge_artists[(0, 1)].set_picker(10) # increases the pick radius
    g.edge_artists[(0, 1)].set_url("https://www.stackoverflow.com")

    g.node_label_artists[1].set_picker(True)
    g.node_label_artists[1].set_url(g.node_label_artists[1].get_text()) # assumes the label text defines the link target

    g.edge_label_artists[(0, 1)].set_picker(True)
    g.edge_label_artists[(0, 1)].set_url(g.edge_label_artists[(0, 1)].get_text()) # ditto

    plt.show()



.. image-sg:: /sphinx_gallery_output/images/sphx_glr_plot_19_hyperlinks_002.png
   :alt: plot 19 hyperlinks
   :srcset: /sphinx_gallery_output/images/sphx_glr_plot_19_hyperlinks_002.png
   :class: sphx-glr-single-img






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

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


.. _sphx_glr_download_sphinx_gallery_output_plot_19_hyperlinks.py:


.. only :: html

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



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

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



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

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


.. only:: html

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

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