nbagg: Don't close figures for bubbled events. #18639
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In JavaScript, the event handlers are called for both the element and also bubbled up from any children. If the Matplotlib figure is the only thing in the output, that's fine, as closing the figure when one of the `canvas` or `div`s clears is the same as when the `OutputArea` is cleared. However, if there are other outputs, such as widgets, we do not want to close the figure if one of them is cleared. As there's no way to clear just the figure output, only close the figure if the _entire_ `OutputArea` div is cleared (i.e., the element we've attached to). Fixes matplotlib#18638.
QuLogic
commented
Oct 2, 2020
| @@ -48,7 +48,7 @@ mpl.mpl_figure_comm = function (comm, msg) { | |||
| console.error('Failed to find cell for figure', id, fig); | |||
| return; | |||
| } | |||
| fig.cell_info[0].output_area.element.one( | |||
| fig.cell_info[0].output_area.element.on( | |||
There was a problem hiding this comment.
Note, since we are now ignoring some events, we can't just attach on the first trigger (.one), but all of them (.on)
timhoffm
approved these changes
Oct 3, 2020
dopplershift
approved these changes
Oct 5, 2020
|
Travis passed, status just didn't update. |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Oct 5, 2020
dopplershift
added a commit
that referenced
this pull request
Oct 5, 2020
…639-on-v3.3.x Backport PR #18639 on branch v3.3.x (nbagg: Don't close figures for bubbled events.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
In JavaScript, the event handlers are called for both the element and also bubbled up from any children. If the Matplotlib figure is the only thing in the output, that's fine, as closing the figure when one of the
canvasordivs clears is the same as when theOutputAreais cleared. However, if there are other outputs, such as widgets, we do not want to close the figure if one of them is cleared.As there's no way to clear just the figure output, only close the figure if the entire
OutputAreadiv is cleared (i.e., the element we've attached to).Fixes #18638.
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsandpydocstyle<4and runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).