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

Omit mag slider in TIFF export if only one mag is available #8297

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

knollengewaechs
Copy link
Contributor

@knollengewaechs knollengewaechs commented Dec 23, 2024

image

URL of deployed dev instance (used for testing):

Steps to test:

  • abc

TODOs:

  • ...

Issues:


(Please delete unneeded items, merge only when none are left open)

@knollengewaechs knollengewaechs self-assigned this Dec 23, 2024
@knollengewaechs knollengewaechs marked this pull request as ready for review December 23, 2024 18:21
Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the download_modal_view.tsx file in the frontend, focusing on improving the magnification selection logic for TIFF export. The changes introduce a new constant onlyOneMagAvailable to determine when only a single magnification option exists for a selected layer. This impacts the rendering of the magnification slider, which is now conditionally displayed based on the available magnification options. Additionally, the display logic for additional coordinates has been refined.

Changes

File Change Summary
frontend/javascripts/oxalis/view/action-bar/download_modal_view.tsx - Added onlyOneMagAvailable constant to check magnification availability
- Conditionally render magnification slider based on available magnifications
- Updated additional coordinates display logic
CHANGELOG.unreleased.md - Updated changelog with user-facing changes, including tooltip for total dataset volume and performance optimizations
- Replaced "resolution" with "magnification" in multiple locations
- Enhanced bounding box tool and fixed various bugs

Assessment against linked issues

Objective Addressed Explanation
Disallow mag selection when only one mag is available [#8002]
Hide slider when only one magnification exists

Possibly related PRs

Suggested labels

frontend, usability

Suggested reviewers

  • philippotto

Poem

🐰 A rabbit's tale of mag and view,
One slider gone, the code rings true,
No more dragging where no choice exists,
Clean UI magic, how it persists!
Export with grace, no needless fuss 🎉


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
frontend/javascripts/oxalis/view/action-bar/download_modal_view.tsx (2)

579-580: Use a clearer variable name or add brief inline documentation.
While “onlyOneMagAvailable” is adequately descriptive, you could consider clarifying the boolean's intent with a short comment, e.g., “True if the layer contains exactly one magnification option.” This helps future maintainers quickly grasp its purpose.


694-695: Confirm the displayed magnification formatting.
Displaying mag.join("-") for a single magnification is fine. In case of non-uniform voxel sizes, this string might be confusing. Consider an explanatory label or tooltip if clarity is needed.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b1242f and 24c512c.

📒 Files selected for processing (1)
  • frontend/javascripts/oxalis/view/action-bar/download_modal_view.tsx (3 hunks)
🔇 Additional comments (2)
frontend/javascripts/oxalis/view/action-bar/download_modal_view.tsx (2)

675-687: Conditionally displaying the magnification slider is effective.
Hiding the slider for single magnification simplifies the UI. Just ensure that removing the slider format does not cause any layout shifts or styling issues. Overall, this approach seems maintainable.


647-647: Ensure consistency when accessing additionalAxes.
The check (selectedLayerInfos.additionalAxes?.length || 0) > 0 is sound. Just verify that additionalAxes is always an array type (or null) per the type definitions.

✅ Verification successful

Let me gather information about the type definitions for additionalAxes by searching through the codebase.


Based on the search results, I can now verify the type definitions. The most relevant type definition is found in frontend/javascripts/types/api_flow_types.ts where additionalAxes is defined as:

readonly additionalAxes: Array<AdditionalAxis> | null;

And in the file under review (download_modal_view.tsx), it's defined as:

additionalAxes?: AdditionalAxis[] | null;

Let me generate the final response:

The additionalAxes type definition is consistent with the null check.
The optional chaining and null coalescing operators are appropriate here as additionalAxes is typed as AdditionalAxis[] | null with optional property modifier (?). The check (selectedLayerInfos.additionalAxes?.length || 0) > 0 safely handles all possible cases: undefined, null, and empty array.

🏁 Scripts executed

The following scripts were executed for the analysis:

Error: No shell scripts found


Script:

#!/bin/bash
# Search for type definitions of additionalAxes
rg -g "*.ts*" "additionalAxes.*:" -A 2

# Search for interface or type definitions that might contain additionalAxes
ast-grep --pattern 'interface $_ {
  $$$
  additionalAxes$_
  $$$
}'

# Also search for type definitions
ast-grep --pattern 'type $_ = {
  $$$
  additionalAxes$_
  $$$
}'

Length of output: 8886

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
CHANGELOG.unreleased.md (1)

39-39: Move changelog entry to the "Changed" section

This change represents a UX improvement by conditionally hiding the magnification slider, rather than fixing a bug. Consider moving this entry from the "Fixed" section to the "Changed" section to better reflect the nature of the modification.

### Changed
+ - Removed the magnification slider for the TIFF export within the download modal if only one magnification is available for the selected layer. [#8297](https://github.com/scalableminds/webknossos/pull/8297)

### Fixed
- - Removed the magnification slider for the TIFF export within the download modal if only one magnification is available for the selected layer. [#8297](https://github.com/scalableminds/webknossos/pull/8297)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 24c512c and be14740.

📒 Files selected for processing (1)
  • CHANGELOG.unreleased.md (1 hunks)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Disallow selecting mag in tiff export modal in case there is only one mag
1 participant