Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check for legend existing before using in _correct_for_scroll_event_on_legend #38015

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

jhaigh0
Copy link
Contributor

@jhaigh0 jhaigh0 commented Sep 18, 2024

Description of work

Found when doing engineering diffraction manual tests
#37992 (comment)

When scrolling on the plots created by the engineering diffraction interface (which have no legends), the following error occurred.

Traceback (most recent call last):
File "C:\MantidNightlyInstall\bin\lib\site-packages\matplotlib\cbook_init_.py", line 314, in process
func(*args, **kwargs)
File "C:\MantidNightlyInstall\bin\lib\site-packages\workbench\plotting\figureinteraction.py", line 141, in on_scroll
self._correct_for_scroll_event_on_legend(event)
File "C:\MantidNightlyInstall\bin\lib\site-packages\workbench\plotting\figureinteraction.py", line 174, in _correct_for_scroll_event_on_legend
if legend.get_draggable() and legend.contains(event):
AttributeError: 'NoneType' object has no attribute 'get_draggable'

There is no associated issue.

To test:

  • Turn on ISIS archive
  • Open Diffraction -> Engineering Diffraction interface
  • Select Create New Calibration and enter 305738
  • Click Calibrate and scroll on the plot which appears, no error should occur.

This does not require release notes because changes added this release


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@jhaigh0 jhaigh0 added Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Found in Beta Issues that were found during the manual/beta/smoke testing period labels Sep 18, 2024
@jhaigh0 jhaigh0 added this to the Release 6.11 milestone Sep 18, 2024
Copy link
Contributor

@yusufjimoh yusufjimoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the quick fix. I was able to scroll plots with and without legends, including those with hidden legends, and the scroll works perfectly with no side effects. I'm happy to approve the pull request

@SilkeSchomann SilkeSchomann self-assigned this Sep 19, 2024
@SilkeSchomann SilkeSchomann merged commit e8fff4a into release-next Sep 19, 2024
10 checks passed
@SilkeSchomann SilkeSchomann deleted the fix_plot_scroll_bug branch September 19, 2024 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Found in Beta Issues that were found during the manual/beta/smoke testing period
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants