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

.. only:: html

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

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

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

.. _sphx_glr_auto_examples_Interactive_plot_figure_annotations.py:


Interactive figure annotations — double-click to add, drag to place
===================================================================

anyplotlib has a *figure-level* annotation layer that floats above the panels,
positioned in **figure fractions** (0…1, origin top-left) rather than any
panel's data coordinates.  Set it with
:meth:`~anyplotlib.Figure.set_figure_markers`; the supported kinds are
``"text"``, ``"circle"``, ``"rect"`` and ``"arrow"``.

Turn on ``fig.edit_chrome`` and every annotation becomes draggable in the
browser.  Combine that with a ``double_click`` handler and you get a simple
annotate-by-clicking workflow: double-click a feature to drop a labelled
arrow, then drag it to line it up.  Positions round-trip back to Python via
:attr:`~anyplotlib.Figure.figure_markers`.

.. GENERATED FROM PYTHON SOURCE LINES 17-31

.. code-block:: Python

    import numpy as np
    import anyplotlib as apl

    rng  = np.random.default_rng(7)
    data = rng.standard_normal((160, 160)).cumsum(0).cumsum(1)
    data = (data - data.min()) / (data.max() - data.min())

    fig, ax = apl.subplots(1, 1, figsize=(520, 520))
    v = ax.imshow(data, cmap="magma", units="px")

    # Enable the editable-annotation ("report builder") mode so figure markers are
    # hit-testable and draggable, and the figure emits background/marker events.
    fig.edit_chrome = True





.. raw:: html

    <div style="display:block;text-align:center;line-height:0;margin:12px 0;"><div id="sphx_glr_plot_figure_annotations_001" class="awi-fig-wrap" data-awi-fig="sphx_glr_plot_figure_annotations_001" style="display:inline-block;overflow:hidden;position:relative;width:536px;height:536px;"><iframe src="../../_static/viewer_widgets/sphx_glr_plot_figure_annotations_001.html" data-awi-fig="sphx_glr_plot_figure_annotations_001" frameborder="0" scrolling="no" style="width:536px;height:536px;border:none;overflow:hidden;display:block;transform-origin:top left;transform:scale(1);position:absolute;top:0;left:0;"></iframe></div><script>(function(){var wrap=document.getElementById('sphx_glr_plot_figure_annotations_001'),ifr=wrap.querySelector('iframe'),nw=536,nh=536;function r(){var avail=wrap.parentElement?wrap.parentElement.offsetWidth:0;if(!avail)return;var s=Math.min(1,avail/nw);wrap.style.width=Math.round(nw*s)+'px';wrap.style.height=Math.round(nh*s)+'px';ifr.style.transform='scale('+s+')';}requestAnimationFrame(r);window.addEventListener('resize',r);})()</script></div>






.. GENERATED FROM PYTHON SOURCE LINES 32-36

Seed a couple of annotations
----------------------------
Each marker is a dict with a ``kind`` and fraction-space geometry.  A text
label and an arrow pointing into the image to start with.

.. GENERATED FROM PYTHON SOURCE LINES 36-47

.. code-block:: Python


    fig.set_figure_markers([
        {"kind": "text", "x": 0.5, "y": 0.06,
         "text": "Double-click a feature to annotate it",
         "color": "#ffffff", "fontsize": 14},
        {"kind": "arrow", "x": 0.20, "y": 0.30, "u": 0.12, "v": 0.12,
         "color": "#ffd54f", "linewidth": 2},
    ])

    fig





.. raw:: html

    <div style="display:block;text-align:center;line-height:0;margin:12px 0;"><div id="sphx_glr_plot_figure_annotations_002" class="awi-fig-wrap" data-awi-fig="sphx_glr_plot_figure_annotations_002" style="display:inline-block;overflow:hidden;position:relative;width:536px;height:536px;"><iframe src="../../_static/viewer_widgets/sphx_glr_plot_figure_annotations_002.html" data-awi-fig="sphx_glr_plot_figure_annotations_002" frameborder="0" scrolling="no" style="width:536px;height:536px;border:none;overflow:hidden;display:block;transform-origin:top left;transform:scale(1);position:absolute;top:0;left:0;"></iframe></div><script>(function(){var wrap=document.getElementById('sphx_glr_plot_figure_annotations_002'),ifr=wrap.querySelector('iframe'),nw=536,nh=536;function r(){var avail=wrap.parentElement?wrap.parentElement.offsetWidth:0;if(!avail)return;var s=Math.min(1,avail/nw);wrap.style.width=Math.round(nw*s)+'px';wrap.style.height=Math.round(nh*s)+'px';ifr.style.transform='scale('+s+')';}requestAnimationFrame(r);window.addEventListener('resize',r);})()</script></div>






.. GENERATED FROM PYTHON SOURCE LINES 48-54

Double-click to drop a new annotation
-------------------------------------
On a single-panel figure the panel nearly fills the canvas, so we turn the
click's device pixels into a figure fraction with the panel's
``display_width`` / ``display_height`` and append an arrow + label there.
Because ``edit_chrome`` is on, the new marker is immediately draggable.

.. GENERATED FROM PYTHON SOURCE LINES 54-79

.. code-block:: Python



    def _on_double_click(event):
        if event.x is None or event.display_width is None:
            return
        fx = float(np.clip(event.x / event.display_width, 0.02, 0.98))
        fy = float(np.clip(event.y / event.display_height, 0.02, 0.98))
        markers = fig.figure_markers            # current list (a copy)
        n = sum(1 for m in markers if m["kind"] == "text")
        markers.append({"kind": "arrow", "x": fx, "y": fy,
                        "u": 0.08, "v": -0.08, "color": "#40c4ff", "linewidth": 2})
        markers.append({"kind": "text", "x": fx + 0.08, "y": fy - 0.10,
                        "text": f"mark {n}", "color": "#40c4ff", "fontsize": 13})
        fig.set_figure_markers(markers)


    v.add_event_handler(_on_double_click, "double_click")

    fig.set_help(
        "Double-click on the image to drop a labelled arrow.\n"
        "Drag any annotation to reposition it (edit mode is on)."
    )

    fig  # Interactive





.. raw:: html

    <div style="display:block;text-align:center;line-height:0;margin:12px 0;"><div id="sphx_glr_plot_figure_annotations_003" class="awi-fig-wrap" data-awi-fig="sphx_glr_plot_figure_annotations_003" style="display:inline-block;overflow:hidden;position:relative;width:536px;height:536px;"><iframe src="../../_static/viewer_widgets/sphx_glr_plot_figure_annotations_003.html" data-awi-fig="sphx_glr_plot_figure_annotations_003" frameborder="0" scrolling="no" style="width:536px;height:536px;border:none;overflow:hidden;display:block;transform-origin:top left;transform:scale(1);position:absolute;top:0;left:0;"></iframe><div class="awi-badge" data-awi-badge="sphx_glr_plot_figure_annotations_003"><button class="awi-badge-icon awi-activate-btn" data-awi-fig="sphx_glr_plot_figure_annotations_003" title="Make interactive (boots Pyodide — may take ~10 s)">&#x26A1;</button></div></div><script>(function(){var wrap=document.getElementById('sphx_glr_plot_figure_annotations_003'),ifr=wrap.querySelector('iframe'),nw=536,nh=536;function r(){var avail=wrap.parentElement?wrap.parentElement.offsetWidth:0;if(!avail)return;var s=Math.min(1,avail/nw);wrap.style.width=Math.round(nw*s)+'px';wrap.style.height=Math.round(nh*s)+'px';ifr.style.transform='scale('+s+')';}requestAnimationFrame(r);window.addEventListener('resize',r);})()</script></div>



.. raw:: html

    <script type="text/x-python" data-fig-id="sphx_glr_plot_figure_annotations_003" data-fig-index="2" data-src-file="plot_figure_annotations" data-src="&quot;\&quot;\&quot;\&quot;\nInteractive figure annotations \u2014 double-click to add, drag to place\n===================================================================\n\nanyplotlib has a *figure-level* annotation layer that floats above the panels,\npositioned in **figure fractions** (0\u20261, origin top-left) rather than any\npanel&#x27;s data coordinates.  Set it with\n:meth:`~anyplotlib.Figure.set_figure_markers`; the supported kinds are\n``\&quot;text\&quot;``, ``\&quot;circle\&quot;``, ``\&quot;rect\&quot;`` and ``\&quot;arrow\&quot;``.\n\nTurn on ``fig.edit_chrome`` and every annotation becomes draggable in the\nbrowser.  Combine that with a ``double_click`` handler and you get a simple\nannotate-by-clicking workflow: double-click a feature to drop a labelled\narrow, then drag it to line it up.  Positions round-trip back to Python via\n:attr:`~anyplotlib.Figure.figure_markers`.\n\&quot;\&quot;\&quot;\nimport numpy as np\nimport anyplotlib as apl\n\nrng  = np.random.default_rng(7)\ndata = rng.standard_normal((160, 160)).cumsum(0).cumsum(1)\ndata = (data - data.min()) / (data.max() - data.min())\n\nfig, ax = apl.subplots(1, 1, figsize=(520, 520))\nv = ax.imshow(data, cmap=\&quot;magma\&quot;, units=\&quot;px\&quot;)\n\n# Enable the editable-annotation (\&quot;report builder\&quot;) mode so figure markers are\n# hit-testable and draggable, and the figure emits background/marker events.\nfig.edit_chrome = True\n\n# %%\n# Seed a couple of annotations\n# ----------------------------\n# Each marker is a dict with a ``kind`` and fraction-space geometry.  A text\n# label and an arrow pointing into the image to start with.\n\nfig.set_figure_markers([\n    {\&quot;kind\&quot;: \&quot;text\&quot;, \&quot;x\&quot;: 0.5, \&quot;y\&quot;: 0.06,\n     \&quot;text\&quot;: \&quot;Double-click a feature to annotate it\&quot;,\n     \&quot;color\&quot;: \&quot;#ffffff\&quot;, \&quot;fontsize\&quot;: 14},\n    {\&quot;kind\&quot;: \&quot;arrow\&quot;, \&quot;x\&quot;: 0.20, \&quot;y\&quot;: 0.30, \&quot;u\&quot;: 0.12, \&quot;v\&quot;: 0.12,\n     \&quot;color\&quot;: \&quot;#ffd54f\&quot;, \&quot;linewidth\&quot;: 2},\n])\n\nfig\n\n# %%\n# Double-click to drop a new annotation\n# -------------------------------------\n# On a single-panel figure the panel nearly fills the canvas, so we turn the\n# click&#x27;s device pixels into a figure fraction with the panel&#x27;s\n# ``display_width`` / ``display_height`` and append an arrow + label there.\n# Because ``edit_chrome`` is on, the new marker is immediately draggable.\n\n\ndef _on_double_click(event):\n    if event.x is None or event.display_width is None:\n        return\n    fx = float(np.clip(event.x / event.display_width, 0.02, 0.98))\n    fy = float(np.clip(event.y / event.display_height, 0.02, 0.98))\n    markers = fig.figure_markers            # current list (a copy)\n    n = sum(1 for m in markers if m[\&quot;kind\&quot;] == \&quot;text\&quot;)\n    markers.append({\&quot;kind\&quot;: \&quot;arrow\&quot;, \&quot;x\&quot;: fx, \&quot;y\&quot;: fy,\n                    \&quot;u\&quot;: 0.08, \&quot;v\&quot;: -0.08, \&quot;color\&quot;: \&quot;#40c4ff\&quot;, \&quot;linewidth\&quot;: 2})\n    markers.append({\&quot;kind\&quot;: \&quot;text\&quot;, \&quot;x\&quot;: fx + 0.08, \&quot;y\&quot;: fy - 0.10,\n                    \&quot;text\&quot;: f\&quot;mark {n}\&quot;, \&quot;color\&quot;: \&quot;#40c4ff\&quot;, \&quot;fontsize\&quot;: 13})\n    fig.set_figure_markers(markers)\n\n\nv.add_event_handler(_on_double_click, \&quot;double_click\&quot;)\n\nfig.set_help(\n    \&quot;Double-click on the image to drop a labelled arrow.\\n\&quot;\n    \&quot;Drag any annotation to reposition it (edit mode is on).\&quot;\n)\n\nfig  # Interactive\n\n# %%\n# Read the placements back\n# ------------------------\n# After the user drags things around, ``fig.figure_markers`` reflects the\n# current fraction positions \u2014 persist them, export them, or feed them into a\n# report.\n\nfor m in fig.figure_markers:\n    print(m[\&quot;kind\&quot;], round(m[\&quot;x\&quot;], 3), round(m[\&quot;y\&quot;], 3))\n&quot;"></script>






.. GENERATED FROM PYTHON SOURCE LINES 80-85

Read the placements back
------------------------
After the user drags things around, ``fig.figure_markers`` reflects the
current fraction positions — persist them, export them, or feed them into a
report.

.. GENERATED FROM PYTHON SOURCE LINES 85-88

.. code-block:: Python


    for m in fig.figure_markers:
        print(m["kind"], round(m["x"], 3), round(m["y"], 3))




.. raw:: html

    <div style="display:block;text-align:center;line-height:0;margin:12px 0;"><div id="sphx_glr_plot_figure_annotations_004" class="awi-fig-wrap" data-awi-fig="sphx_glr_plot_figure_annotations_004" style="display:inline-block;overflow:hidden;position:relative;width:536px;height:536px;"><iframe src="../../_static/viewer_widgets/sphx_glr_plot_figure_annotations_004.html" data-awi-fig="sphx_glr_plot_figure_annotations_004" frameborder="0" scrolling="no" style="width:536px;height:536px;border:none;overflow:hidden;display:block;transform-origin:top left;transform:scale(1);position:absolute;top:0;left:0;"></iframe></div><script>(function(){var wrap=document.getElementById('sphx_glr_plot_figure_annotations_004'),ifr=wrap.querySelector('iframe'),nw=536,nh=536;function r(){var avail=wrap.parentElement?wrap.parentElement.offsetWidth:0;if(!avail)return;var s=Math.min(1,avail/nw);wrap.style.width=Math.round(nw*s)+'px';wrap.style.height=Math.round(nh*s)+'px';ifr.style.transform='scale('+s+')';}requestAnimationFrame(r);window.addEventListener('resize',r);})()</script></div>



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

 .. code-block:: none

    text 0.5 0.06
    arrow 0.2 0.3





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

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


.. _sphx_glr_download_auto_examples_Interactive_plot_figure_annotations.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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