biopeaks icon indicating copy to clipboard operation
biopeaks copied to clipboard

GUI Questions

Open TomDonoghue opened this issue 3 years ago • 5 comments

As I was going through the user guide (https://jancbrammer.github.io/biopeaks/user_guide.html), there were a couple things that either I couldn't figure out how to do (could be better documented), or that don't seem to be available (might want to be added).

  • is there a way to re-open the configuration box, once it has been closed?
    • at some point I closed it, and it wasn't clear how to get it back
  • is there a way to unload a currently loaded signal?
    • I didn't see a clear way to do this, so I would just restart the program when I wanted to load a new signal

TomDonoghue avatar Sep 29 '20 05:09 TomDonoghue

@TomDonoghue, the visibility of the configuration panel can be toggled in the menu bar. This is mentioned in the layout of the interface section of the user guide.

grafik

There is no explicit way to unload the current signal. However, simply loading a new signal clears the state associated with the previous signal. This is mentioned in the last two sentences of the load biosignal section of the user guide.

JanCBrammer avatar Sep 29 '20 12:09 JanCBrammer

Huh, not sure if this is a version, thing or OS difference or something, but this is what I see for the menus: Screen Shot 2020-09-29 at 9 26 09 AM

^As well as not having the show/hide buttons, my menu buttons show up on the global taskbar, not on the biopeaks box.

The toggle as it should appear looks good / makes sense, I'm just not sure why I wasn't seeing it.

Unloading by re-loading makes sense, my bad on missing that in the docs.

TomDonoghue avatar Sep 29 '20 16:09 TomDonoghue

Huh, that's interesting. The show/hide button was added in the second-last version (see changelog). So my best guess is that this is an OS thing?

In case you have a development version of biopeaks installed, you could try if the following has an effect.

After https://github.com/JanCBrammer/biopeaks/blob/416ad91766ca8e07ed3437f1ecc1f807e8e2fb03/biopeaks/view.py#L271

add

menubar.setNativeMenuBar(False)

JanCBrammer avatar Sep 30 '20 06:09 JanCBrammer

I installed from PYPI, following the installing instructions, which got me version 1.4.0

The menubar.setNativeMenuBar(False) line does not appear in view.py in this downloaded and installed version. So I think it's just a version difference (assuming that would fix it).

I would probably aim for a new PYPI release soon, perhaps before / with the paper.

One thing to keep in mind is keeping the released version and documentation in sync. Right now, the screenshots in the user guide have the updated menubar, but this is ahead of the actual release version, which is a little confusing. It might be worthwhile aiming for a more integrated update procedure, to help keep release versions & documentation in step with each other.

TomDonoghue avatar Sep 30 '20 16:09 TomDonoghue

The menubar.setNativeMenuBar(False) line does not appear in view.py in this downloaded and installed version.

I think my description was a little ambiguous. menubar.setNativeMenuBar(False) is currently not in version 1.4.0. I was just curious if adding that line to 1.4.0 on MacOS would make the hide/show button appear (I currently cannot test this myself).

JanCBrammer avatar Oct 01 '20 04:10 JanCBrammer