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.

Sign up for GitHub

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

Jump to bottom

data-menu: handle associated data layer logic #3370

Merged
merged 4 commits into from
Dec 20, 2024
Merged

data-menu: handle associated data layer logic #3370

merged 4 commits into from
Dec 20, 2024

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Dec 20, 2024 •
edited
Loading

Description

This pull request implements logic to ensure a parent data layer is visible when enabling a child data-layer and to hide child layers when disabling the parent data-layer.

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@kecnry kecnry added this to the 4.1 milestone Dec 20, 2024
@github-actions github-actions bot added the plugin Label for plugins common to multiple configurations label Dec 20, 2024
@kecnry kecnry marked this pull request as ready for review December 20, 2024 17:42
@kecnry kecnry added the trivial Only needs one approval instead of two label Dec 20, 2024
bmorris3
bmorris3 reviewed Dec 20, 2024
View reviewed changes
jdaviz/configs/default/plugins/data_menu/data_menu.py
# so also hide the child-layer
layer.visible = False

if visible and (parent_label := self.app._get_assoc_data_parent(layer_label)):
Copy link
Contributor

Choose a reason for hiding this comment

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

I am the walrus.

bmorris3
bmorris3 reviewed Dec 20, 2024
View reviewed changes
jdaviz/configs/default/plugins/data_menu/data_menu.py
Comment on lines +366 to +368
if visible and (parent_label := self.app._get_assoc_data_parent(layer_label)):
# ensure the parent layer is also visible
self.set_layer_visibility(parent_label, visible=True)
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this mean that you can make a DQ layer visible for a data entry that is currently invisible, and doing so also toggles the parent layer visibility? I think you can't do that in the current data menu, but I don't oppose to choosing that behavior going forward.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes. The current data-menu disables the ability to set a child-of-a-non-visible-parent to visible. That's also an option here, but since we don't (yet) have the design to visually tie them and don't have a clear way to denote that in the UI, I figured this might be a reasonable alternative. What would you prefer?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's good like this.

jdaviz/configs/default/tests/test_data_menu.py Outdated Show resolved Hide resolved
bmorris3
bmorris3 approved these changes Dec 20, 2024
View reviewed changes
Copy link
Contributor

@bmorris3 bmorris3 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

If this comment works out, please use that approach in the test.

@kecnry kecnry merged commit 5cd23a8 into spacetelescope:main Dec 20, 2024
18 checks passed
@kecnry kecnry deleted the dm-child-layers branch December 20, 2024 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmorris3 bmorris3 bmorris3 approved these changes

@rosteen rosteen Awaiting requested review from rosteen rosteen is a code owner

@javerbukh javerbukh Awaiting requested review from javerbukh javerbukh is a code owner

@pllim pllim Awaiting requested review from pllim pllim is a code owner

@haticekaratay haticekaratay Awaiting requested review from haticekaratay haticekaratay is a code owner

@cshanahan1 cshanahan1 Awaiting requested review from cshanahan1 cshanahan1 is a code owner

@gibsongreen gibsongreen Awaiting requested review from gibsongreen gibsongreen is a code owner

Assignees
No one assigned
Labels
plugin Label for plugins common to multiple configurations trivial Only needs one approval instead of two
Projects
None yet
Milestone
4.1
Development

Successfully merging this pull request may close these issues.
3 participants
@kecnry @pllim @bmorris3