Skip to content

[Bug]: subfigure artists not drawn interactively #28384

Closed

Description

@rcomer

Bug summary

When artists are added to a subfigure in interactive mode, they do not appear until I force a draw by resizing the window.

Code for reproduction

$ ipython --matplotlib=qt
Python 3.12.3 | packaged by conda-forge | (main, Apr 15 2024, 18:38:13) [GCC 12.3.0]
Type 'copyright', 'credits' or 'license' for more information
IPython 8.24.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]: import matplotlib.pyplot as plt

In [2]: fig = plt.figure()

In [3]: sfig1, sfig2 = fig.subfigures(ncols=2)

In [4]: sfig2.suptitle("My Title")
Out[4]: Text(0.5, 0.98, 'My Title')

In [5]: ax = sfig1.subplots()

In [6]: ax.plot([1, 3, 2])
Out[6]: [<matplotlib.lines.Line2D at 0x73a220908ce0>]

Actual outcome

Apparently empty figure
image

Expected outcome

If I resize the window, the artists appear
image

Additional information

No response

Operating system

Ubuntu

Matplotlib Version

main

Matplotlib Backend

QtAgg and TkAgg

Python version

3.12.3

Jupyter version

No response

Installation

git checkout

Activity

  1. tacaswell commented on Jun 12, 2024

    @tacaswell
    Member

    Very likely the issue is that obj.stale is not propogating up from the sub-figure to the parent.

  2. jklymak commented on Jun 12, 2024

    @jklymak
    Member

    Huh. I never use interactive mode so didn't test that! Seems a pretty big oversight. Thanks for finding.

  3. tacaswell commented on Jun 13, 2024

    @tacaswell
    Member
    diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
    index 9139b2ed26..9f764cc233 100644
    --- a/lib/matplotlib/figure.py
    +++ b/lib/matplotlib/figure.py
    @@ -1636,6 +1636,8 @@ default: %(va)s
             sf = SubFigure(self, subplotspec, **kwargs)
             self.subfigs += [sf]
             sf._remove_method = self.subfigs.remove
    +        sf.stale_callback = _stale_figure_callback
    +        self.stale = True
             return sf
     
         def sca(self, a):
    

    is the fix. I don't have time right now to add a test etc. I'll try to get to it later today but will not be at all angry if someone takes over.

  4. added this to the v3.9.1 milestone on Jun 13, 2024
  5. rcomer commented on Jun 14, 2024

    @rcomer
    MemberAuthor

    @tacaswell does it matter that that callback will currently only set the root figure to stale and not any intermediate subfigures when they are nested?

    If it does matter, we can just wait for #28177 and then update the callback to work on self.get_figure(root=False).

  6. rcomer commented on Jun 14, 2024

    @rcomer
    MemberAuthor

    Full disclosure: this is how far I got
    main...rcomer:matplotlib:subfigure-stale

    Currently the last line of the test fails. I tried and failed to create an example to show that this matters.

    Sorry, I probably should have commented right after I did this to avoid duplicating effort.

  7. tacaswell commented on Jun 14, 2024

    @tacaswell
    Member

    Ah, no worries. I was feeling guilty that my initial comment had too little detail and I was wasting your time digging!

    I think waiting for #28177 to land might make sense, but it is not critical as either way, the thing that triggers the automatic re-rendering is the stale state of the top-level figure (via

    def draw_all(cls, force=False):
    """
    Redraw all stale managed figures, or, if *force* is True, all managed
    figures.
    """
    for manager in cls.get_all_fig_managers():
    if force or manager.canvas.figure.stale:
    manager.canvas.draw_idle()
    which is called either via
    ip.events.register("post_execute", _draw_all_if_interactive)
    after executing a cell/line in IPython or
    if _REPL_DISPLAYHOOK is _ReplDisplayHook.PLAIN:
    fig.stale_callback = _auto_draw_if_interactive
    in plain Python)

  8. rcomer commented on Jun 14, 2024

    @rcomer
    MemberAuthor

    Thanks @tacaswell! So, when the top Figure is re-drawn, does it re-draw all the artists on it, or just those ones that are currently marked "stale"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions