Refactor Main Window status bar to improve information presentation #5451

Czaki · 2022-12-28T16:54:55Z

Description

In this PR I implemented a custom layout for status bar messages to ensure that as much information as possible will be presented.

napari_statusbar-2022-12-28_17.47.55.mp4

In this PR I ensure that a minimal part of every label, except help, will be presented. If enough space is available, then also help text is presented.

Type of change

Bug-fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

References

closes #5417

How has this been tested?

example: the test suite for my feature covers cases x, y, and z
example: all tests pass with my change
example: I check if my changes works with both PySide and PyQt backends
as there are small differences between the two Qt bindings.

Final checklist:

My PR is the minimum possible work for the desired functionality
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
If I included new strings, I have used trans. to make them localizable.
For more information see our translations guide.

codecov · 2022-12-28T17:15:34Z

Codecov Report

Merging #5451 (0247b17) into main (465c281) will decrease coverage by 0.04%.
The diff coverage is 98.73%.

@@            Coverage Diff             @@
##             main    #5451      +/-   ##
==========================================
- Coverage   89.31%   89.27%   -0.04%     
==========================================
  Files         600      600              
  Lines       51019    51060      +41     
==========================================
+ Hits        45566    45584      +18     
- Misses       5453     5476      +23

Impacted Files	Coverage Δ
napari/_qt/widgets/qt_viewer_status_bar.py	`91.45% <98.73%> (+8.55%)`	⬆️
napari/_tests/test_draw.py	`36.84% <0.00%> (-63.16%)`	⬇️
napari/components/experimental/chunk/_pool.py	`85.71% <0.00%> (-7.94%)`	⬇️
napari/_qt/widgets/qt_color_swatch.py	`71.54% <0.00%> (-3.26%)`	⬇️
napari/utils/interactions.py	`74.52% <0.00%> (-2.84%)`	⬇️
napari/utils/info.py	`78.35% <0.00%> (-2.07%)`	⬇️
napari/components/experimental/chunk/_loader.py	`71.66% <0.00%> (-1.67%)`	⬇️
napari/_qt/qt_event_loop.py	`80.27% <0.00%> (-0.69%)`	⬇️
napari/_qt/qt_main_window.py	`74.39% <0.00%> (-0.18%)`	⬇️
napari/_qt/dialogs/qt_package_installer.py	`81.67% <0.00%> (+0.39%)`	⬆️
... and 2 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

brisvag · 2023-01-13T08:52:46Z

Thsi is great! I tried to do this myself, but got completely lost very fast :P

This solves #5177 too right?

brisvag · 2023-01-13T08:55:46Z

napari/_qt/widgets/qt_viewer_status_bar.py

+        # magical nuber +2 is from superqt code
+        # magical number +6 is from experiments


What do these magic numbers do? Increase the base width a bit?

What do these magic numbers do? Increase the base width a bit?

Yes, It it is to prevent eliding text if there is enough space.

Ah, makes sense :)

except there is no +6 in the code, only +8! 😂 Could you maybe elaborate in the comments based on this discussion?

I need to bump the value to 12 after merging main. I hate this, and I do not know how to do it in a proper way...

Czaki · 2023-01-13T08:56:41Z

This solves #5177 too right?

Exploding windows, yes. Blinking, I do not know.

brisvag

Yup, I tested it and it works!

Czaki · 2023-01-13T14:06:22Z

It would be nice if someone with another OS (MacOS, Windows) could test it. @psobolewskiPhD @andy-sweet ?

jni · 2023-01-13T14:15:03Z

Nice @Czaki!

Just did a quick test, and on macOS the data occludes the start of the help message sometimes, and the text baseline alignment is a bit off between the two messages:

Screen.Recording.2023-01-14.at.1.09.34.am.mov

To be honest I'm not 100% sure that this is the best experience... The jittery text is disconcerting... But I don't have a strong opinion, and it solves real issues, so that's 👍.

psobolewskiPhD · 2023-01-13T14:23:44Z

@jni Maybe for another PR, but I think the help message regarding Tools keybinds shouldn't show all the time, especially when hovering over data. Maybe only show when the mouse is outside the canvas? or just inside the LayerControls? Or just when the layer is created and then once the user does something, drop it?
The tooltips of the tools now show the keybinds, so it's not so crucial and we don't have any of those toggle/secondaries like there used to be that were not discoverable. Now 2ndary keybinds are set in the preferences like everything else.

Czaki · 2023-01-13T18:06:16Z

@jni Could you test the current version? Jitter should be fixed.

Czaki · 2023-01-13T18:12:42Z

@jni Maybe for another PR, but I think the help message regarding Tools keybinds shouldn't show all the time, especially when hovering over data. Maybe only show when the mouse is outside the canvas? or just inside the LayerControls? Or just when the layer is created and then once the user does something, drop it?

hide help text is easy and could be done in this PR. The question is what we want.

psobolewskiPhD · 2023-01-13T21:42:21Z

@Czaki On my mac there is a subtle visual glitch when hovering the bottom rectangle:

The u is just slightly cut.
Otherwise, works great, no jitter or baseline issues.

Note that when I hover the top two boxes, the help stuff is gone 👍
Looking at @jni video again, the help stuff isn't even helpful once it's truncated <1> Blah blah <2> ....
So dumping it to make more room for the informative stuff is better IMO.

Czaki · 2023-01-13T22:27:33Z

The u is just slightly cut.

This is connected with QElidingLabel and its detection of when to elide.

brisvag · 2023-01-16T10:26:54Z

I agree on dumping the help rather than truncating it. I think we should handle help better anyways (perhaps with a modal dialog if someone presses h)

Czaki · 2023-01-18T10:54:32Z

napari/_qt/widgets/qt_viewer_status_bar.py

+        if coordinates_width:
+            help_width = 0


@jni @brisvag
These two lines remove help text when mouse is over canvas (as there is non empty coordinate text)

Could you test it? Maybe help text should be shown if there are only coordinates but no properties?

🔥
I love it. Works great.

Maybe help text should be shown if there are only coordinates but no properties?

Either way is fine for me.

I think consistency is better. Keep it simple:

Mouse in canvas: data/properties info.

Mouse in layers/tools: tools help.

Czaki · 2023-01-23T15:53:43Z

During the community meeting, I got positive feedback on the current state. Let's start 24 hours clock.

* main: (38 commits) Fix `test_worker_with_progress` by wait on worker end (napari#5548) Un-set unified title and tool bar on mac (Qt property) (napari#5533) Set PYTHONEXECUTABLE as part of macos fixes on (re)startup (napari#5531) Fix key error issue of action manager (napari#5539) Clean dangling widget in test (napari#5544) Use pytest-pretty for better log readability (napari#5525) Update vendoring tool to check on matplotlib colormap (napari#5181) MAINT: add time limit for CI. (napari#5495) Add show_debug notification (napari#5101) Overlays 2.0 (napari#4894) Clarify layer's editable property and separate interaction with visible property (napari#5413) ci(dependabot): bump docker/build-push-action from 3 to 4 (napari#5523) Fix opening file dialogs in PySide (napari#5492) [pre-commit.ci] pre-commit autoupdate (napari#5518) Replace flake8, isort and pyupgrade by ruff, enable additional usefull rules (napari#5513) MAINT: Don't format logs in log call (napari#5504) Fix conda avaliability check (napari#5496) Handle case when QtDims play thread is partially deleted (napari#5499) Bugfix: Add missing Enums and Flags required by PySide6 > 6.4 (napari#5480) Refactor Main Window status bar to improve information presentation (napari#5451) ...

…5451) closes #5417

Czaki added 5 commits December 28, 2022 14:24

simplify setStatusText

8d19532

set name for objects

3c78e8a

update size policy on set properties

546f1e2

better provide plugin reader

fdad145

use custom mangement of widgets positions

71a1633

github-actions bot added the qt Relates to qt label Dec 28, 2022

github-actions bot assigned Czaki Dec 28, 2022

brisvag reviewed Jan 13, 2023

View reviewed changes

brisvag approved these changes Jan 13, 2023

View reviewed changes

Czaki added 2 commits January 13, 2023 15:09

add more information about magical numbers when calculate size

59ef6f8

Merge branch 'main' into bugfix/status_bar

e468d38

fix aligment

335a5d5

remove help text if mouse over canvas

1e82834

Czaki commented Jan 18, 2023

View reviewed changes

Merge branch 'main' into bugfix/status_bar

0247b17

brisvag approved these changes Jan 23, 2023

View reviewed changes

Czaki merged commit 180992f into napari:main Jan 24, 2023

Czaki deleted the bugfix/status_bar branch January 24, 2023 19:58

brisvag mentioned this pull request Jan 26, 2023

Many features result in GUI stutter on call of get_value #5177

Closed

Czaki added this to the 0.5.0 milestone Feb 5, 2023

Czaki added the bugfix PR with bugfix label Feb 5, 2023

This was referenced Mar 10, 2023

Having many features in layer.features leads to napari window changing size when user hovers over objects #5617

Closed

Window resizes very wide if labels have lots of features #5639

Closed

Czaki mentioned this pull request Jun 7, 2023

v0.4.18 - release process #5911

Closed

Czaki modified the milestones: 0.5.0, 0.4.18 Jun 16, 2023

Czaki added the triaged-0.4.18 To mark PR that is triaged in 0.4.18 release process label Jun 16, 2023

Czaki added a commit that referenced this pull request Jun 16, 2023

Refactor Main Window status bar to improve information presentation (#…

5854677

…5451) closes #5417

Czaki added a commit that referenced this pull request Jun 17, 2023

Refactor Main Window status bar to improve information presentation (#…

4cf6d52

…5451) closes #5417

Czaki added a commit that referenced this pull request Jun 18, 2023

Refactor Main Window status bar to improve information presentation (#…

7ffadc7

…5451) closes #5417

Czaki added a commit that referenced this pull request Jun 19, 2023

Refactor Main Window status bar to improve information presentation (#…

6398358

…5451) closes #5417

Czaki added a commit that referenced this pull request Jun 21, 2023

Refactor Main Window status bar to improve information presentation (#…

de51fa0

…5451) closes #5417

Czaki added a commit that referenced this pull request Jun 21, 2023

Refactor Main Window status bar to improve information presentation (#…

7872576

…5451) closes #5417

Czaki added a commit that referenced this pull request Jun 21, 2023

Refactor Main Window status bar to improve information presentation (#…

9a062b6

…5451) closes #5417

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Main Window status bar to improve information presentation #5451

Refactor Main Window status bar to improve information presentation #5451

Czaki commented Dec 28, 2022

codecov bot commented Dec 28, 2022 •

edited

Loading

brisvag commented Jan 13, 2023

brisvag Jan 13, 2023

Czaki Jan 13, 2023

brisvag Jan 13, 2023

jni Jan 13, 2023

Czaki Jan 13, 2023

Czaki commented Jan 13, 2023

brisvag left a comment

Czaki commented Jan 13, 2023

jni commented Jan 13, 2023

psobolewskiPhD commented Jan 13, 2023

Czaki commented Jan 13, 2023

Czaki commented Jan 13, 2023

psobolewskiPhD commented Jan 13, 2023 •

edited

Loading

Czaki commented Jan 13, 2023

brisvag commented Jan 16, 2023

Czaki Jan 18, 2023

psobolewskiPhD Jan 18, 2023 •

edited

Loading

brisvag Jan 18, 2023

psobolewskiPhD Jan 18, 2023

Czaki commented Jan 23, 2023

		# magical nuber +2 is from superqt code
		# magical number +6 is from experiments

Refactor Main Window status bar to improve information presentation #5451

Refactor Main Window status bar to improve information presentation #5451

Conversation

Czaki commented Dec 28, 2022

Description

Type of change

References

How has this been tested?

Final checklist:

codecov bot commented Dec 28, 2022 • edited Loading

Codecov Report

brisvag commented Jan 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Czaki commented Jan 13, 2023

brisvag left a comment

Choose a reason for hiding this comment

Czaki commented Jan 13, 2023

jni commented Jan 13, 2023

psobolewskiPhD commented Jan 13, 2023

Czaki commented Jan 13, 2023

Czaki commented Jan 13, 2023

psobolewskiPhD commented Jan 13, 2023 • edited Loading

Czaki commented Jan 13, 2023

brisvag commented Jan 16, 2023

Choose a reason for hiding this comment

psobolewskiPhD Jan 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Czaki commented Jan 23, 2023

codecov bot commented Dec 28, 2022 •

edited

Loading

psobolewskiPhD commented Jan 13, 2023 •

edited

Loading

psobolewskiPhD Jan 18, 2023 •

edited

Loading